TextLabel Class |
Represents a 3d text label.
Inheritance HierarchySystemObject
SampSharp.GameMode.ToolsDisposable
SampSharp.GameMode.PoolsIdentifiedPoolTextLabel
SampSharp.GameMode.WorldTextLabel
SampSharp.GameMode.ToolsDisposable
SampSharp.GameMode.PoolsIdentifiedPoolTextLabel
SampSharp.GameMode.WorldTextLabel
Namespace: SampSharp.GameMode.World
Assembly: SampSharp.GameMode (in SampSharp.GameMode.dll) Version: 0.0.0-local+709673996c0cc3c0733358a87691d1009326afa7
SyntaxC#
public class TextLabel : IdentifiedPool<TextLabel>
The TextLabel type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextLabel(String, Color, Vector3, Single) |
Initializes a new instance of the TextLabel class.
|
| TextLabel(String, Color, Vector3, Single, Int32) |
Initializes a new instance of the TextLabel class.
|
| TextLabel(String, Color, Vector3, Single, Int32, Boolean) |
Initializes a new instance of the TextLabel class.
|
Properties| Name | Description | |
|---|---|---|
 | Color |
Gets or sets the color of this TextLabel.
|
| DrawDistance |
Gets or sets the draw distance of this TextLabel.
|
| Id |
Gets the identifier of this instance.
(Inherited from IdentifiedPoolTInstance.) |
| IsDisposed |
Gets whether this resource has been disposed.
(Inherited from Disposable.) |
| Position |
Gets or sets the position of this TextLabel.
|
| TestLOS |
Gets or sets a value indicating whether the line of sight should be tested before drawing this
TextLabel.
|
| Text |
Gets or sets the text of this TextLabel.
|
| VirtualWorld |
Gets or sets the virtual world of this TextLabel.
|
Methods| Name | Description | |
|---|---|---|
 | AssertNotDisposed |
Checks whether this instance has been disposed. If it has, it throws an exception.
(Inherited from Disposable.) |
| AttachTo(BasePlayer, Vector3) |
Attaches this TextLabel to the specified player.
|
| AttachTo(BaseVehicle, Vector3) |
Attaches this TextLabel to the specified vehicle.
|
| 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 IdentifiedPoolTInstanceDispose(Boolean).) |
| Equals | (Inherited from Object.) |
| Finalize |
Finalizes an instance of the Disposable class.
(Inherited from Disposable.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| Initialize |
An overloadable point for initialization logic which requires the Id to be set.
(Inherited from IdentifiedPoolTInstance.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Occurs when this isntance has been disposed.
(Inherited from Disposable.) |
Fields| Name | Description | |
|---|---|---|
  | InvalidId |
Identifier indicating the handle is invalid.
|
| Max |
Maximum number of per-player text labels which can exist.
|
See Also