TextDraw Class |
Represents a textdraw.
Inheritance HierarchySystemObject
SampSharp.GameMode.ToolsDisposable
SampSharp.GameMode.PoolsIdentifiedPoolTextDraw
SampSharp.GameMode.DisplayTextDraw
SampSharp.GameMode.ToolsDisposable
SampSharp.GameMode.PoolsIdentifiedPoolTextDraw
SampSharp.GameMode.DisplayTextDraw
Namespace: SampSharp.GameMode.Display
Assembly: SampSharp.GameMode (in SampSharp.GameMode.dll) Version: 0.0.0-localbuild+05637d43e9f34d872e453289d4e240c843e43b09
SyntaxC#
public class TextDraw : IdentifiedPool<TextDraw>
The TextDraw type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextDraw |
Initializes a new instance of the TextDraw class.
|
| TextDraw(Vector2, String) |
Initializes a new instance of the TextDraw class.
|
| TextDraw(Vector2, String, TextDrawFont) |
Initializes a new instance of the TextDraw class.
|
| TextDraw(Vector2, String, TextDrawFont, Color) |
Initializes a new instance of the TextDraw class.
|
Properties| Name | Description | |
|---|---|---|
 | Alignment |
Gets or sets the TextDrawAlignment of this textdraw.
|
| BackColor |
Gets or sets the background Color of this textdraw.
|
| BoxColor |
Gets or sets the box Color of this textdraw.
|
| Font |
Gets or sets the TextDrawFont to use in this textdraw.
|
| ForeColor |
Gets or sets the foreground Color of this textdraw.
|
| Height |
Gets or sets the height of this textdraw's box.
|
| Id |
Gets the identifier of this instance.
(Inherited from IdentifiedPoolTInstance.) |
| IsApplyFixes |
Gets or sets whether SA-MP fixes should be applied.
|
| IsDisposed |
Gets whether this resource has been disposed.
(Inherited from Disposable.) |
| LetterSize |
Gets or sets the size of the letters of this textdraw.
|
| Outline |
Gets or sets the outline size of this textdraw.
|
| Position |
Gets or sets the position of this textdraw on the screen.
|
| PreviewModel |
Gets or sets the previewmodel to draw on this textdraw.
|
| PreviewPrimaryColor |
Gets or sets the primary vehicle color of this textdraw's previewmodel.
|
| PreviewRotation |
Gets or sets the rotation of this textdraw's previewmodel.
|
| PreviewSecondaryColor |
Gets or sets the secondary vehicle color of this textdraw's previewmodel.
|
| PreviewZoom |
Gets or sets the zoom level of this textdraw's previewmodel.
|
| Proportional |
Gets or sets whether to proporionally space the characters of this textdraw.
|
| Selectable |
Gets or sets whether this textdraw is selectable.
|
| Shadow |
Gets or sets the shadow-size of this textdraw.
|
| Text |
Gets or sets the text of this textdraw.
|
| UseBox |
Gets or sets whether to draw a box behind the textdraw.
|
| Width |
Gets or sets the width of this textdraw's box.
|
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 IdentifiedPoolTInstanceDispose(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.) |
| FixString |
Fixes a string so no SA-MP bugs will occur during application.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Hide |
Hides this textdraw.
|
| Hide(BasePlayer) |
Hides this textdraw for the given player.
|
| Initialize |
An overloadable point for initialization logic which requires the Id to be set.
(Inherited from IdentifiedPoolTInstance.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnClick |
Raises the Click event.
|
| Refresh |
Recreates this textdraw with all set properties. Called when changing the location on the screen.
|
| Show |
Displays this textdraw to all players.
|
| Show(BasePlayer) |
Display this textdraw to the given player.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateClients |
Updates this textdraw on all client's screens.
|
Events| Name | Description | |
|---|---|---|
 | Click |
Occurs when the OnPlayerClickTextDraw(BasePlayer, ClickTextDrawEventArgs) is being called.
This callback is called when a player clicks on a textdraw or cancels the select mode(ESC).
|
| 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 text draws which can exist.
|
See Also