PlayerTextLabel Class

Represents a player text label.

Inheritance Hierarchy

SystemObject
  SampSharp.GameMode.ToolsDisposable
    SampSharp.GameMode.PoolsIdentifiedOwnedPoolPlayerTextLabel, BasePlayer
      SampSharp.GameMode.WorldPlayerTextLabel

Namespace: SampSharp.GameMode.World
Assembly: SampSharp.GameMode (in SampSharp.GameMode.dll) Version: 0.0.0-localbuild+05637d43e9f34d872e453289d4e240c843e43b09

Syntax

Copy

public class PlayerTextLabel : IdentifiedOwnedPool<PlayerTextLabel, BasePlayer>

The PlayerTextLabel type exposes the following members.

Constructors

	Name	Description
	PlayerTextLabel(BasePlayer, String, Color, Vector3, Single)	Initializes a new instance of the PlayerTextLabel class.
	PlayerTextLabel(BasePlayer, String, Color, Vector3, Single, BasePlayer)	Initializes a new instance of the PlayerTextLabel class.
	PlayerTextLabel(BasePlayer, String, Color, Vector3, Single, BaseVehicle)	Initializes a new instance of the PlayerTextLabel class.
	PlayerTextLabel(BasePlayer, String, Color, Vector3, Single, Boolean)	Initializes a new instance of the PlayerTextLabel class.
	PlayerTextLabel(BasePlayer, String, Color, Vector3, Single, Boolean, BasePlayer)	Initializes a new instance of the PlayerTextLabel class.
	PlayerTextLabel(BasePlayer, String, Color, Vector3, Single, Boolean, BaseVehicle)	Initializes a new instance of the PlayerTextLabel class.

Top

Properties

	Name	Description
	AttachedPlayer	Gets or sets the attached player.
	AttachedVehicle	Gets or sets the attached vehicle.
	Color	Gets or sets the color of this PlayerTextLabel.
	DrawDistance	Gets or sets the draw distance.
	Id	Gets the identifier of this instance. (Inherited from IdentifiedOwnedPoolTInstance, TOwner.)
	IsDisposed	Gets whether this resource has been disposed. (Inherited from Disposable.)
	Owner	Gets the owner of this instance. (Inherited from IdentifiedOwnedPoolTInstance, TOwner.)
	Position	Gets or sets the position of this PlayerTextLabel.
	TestLOS	Gets or sets a value indicating whether to test the line of sight.
	Text	Gets or sets the text of this PlayerTextLabel.

Top

Methods

	Name	Description
	AssertNotDisposed	Checks whether this instance has been disposed. If it has, it throws an exception. (Inherited from Disposable.)
	Dispose	Performs tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from Disposable.)
	Dispose(Boolean)	Performs tasks associated with freeing, releasing, or resetting unmanaged resources. (Overrides IdentifiedOwnedPoolTInstance, TOwnerDispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes an instance of the Disposable class. (Inherited from Disposable.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	An overloadable point for initialization logic which requires the Id and the Owner to be set. (Inherited from IdentifiedOwnedPoolTInstance, TOwner.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Disposed	Occurs when this isntance has been disposed. (Inherited from Disposable.)

Top

Fields

	Name	Description
	InvalidId	Identifier indicating the handle is invalid.
	Max	Maximum number of per-player text labels which can exist.

Top

Reference

SampSharp.GameMode.World Namespace