PlayerTextDraw Class

Represents a player-textdraw.

Inheritance Hierarchy

SystemObject
  SampSharp.GameMode.ToolsDisposable
    SampSharp.GameMode.PoolsIdentifiedOwnedPoolPlayerTextDraw, BasePlayer
      SampSharp.GameMode.DisplayPlayerTextDraw

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

Syntax

Copy

public class PlayerTextDraw : IdentifiedOwnedPool<PlayerTextDraw, BasePlayer>

The PlayerTextDraw type exposes the following members.

Constructors

	Name	Description
	PlayerTextDraw(BasePlayer)	Initializes a new instance of the PlayerTextDraw class.
	PlayerTextDraw(BasePlayer, Vector2, String)	Initializes a new instance of the PlayerTextDraw class.
	PlayerTextDraw(BasePlayer, Vector2, String, TextDrawFont)	Initializes a new instance of the PlayerTextDraw class.
	PlayerTextDraw(BasePlayer, Vector2, String, TextDrawFont, Color)	Initializes a new instance of the PlayerTextDraw class.

Top

Properties

	Name	Description
	Alignment	Gets or sets the TextDrawAlignment of this player-textdraw.
	AutoDestroy	Gets or sets whether the textdraw should automatically be destroyed when hidden.
	BackColor	Gets or sets the background Color of this player-textdraw.
	BoxColor	Gets or sets the box Color of this player-textdraw.
	Font	Gets or sets the TextDrawFont to use in this player-textdraw.
	ForeColor	Gets or sets the foreground Color of this player-textdraw.
	Height	Gets or sets the height of this player-textdraw's box.
	Id	Gets the identifier of this instance. (Inherited from IdentifiedOwnedPoolTInstance, TOwner.)
	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 player-textdraw.
	Outline	Gets or sets the outline size of this player-textdraw.
	Owner	Gets the owner of this instance. (Inherited from IdentifiedOwnedPoolTInstance, TOwner.)
	Position	Gets or sets the position of this player-textdraw on the screen.
	PreviewModel	Gets or sets the preview model to draw on this player-textdraw.
	PreviewPrimaryColor	Gets or sets the primary vehicle color of this player-textdraw's preview model.
	PreviewRotation	Gets or sets the rotation of this player-textdraw's preview model.
	PreviewSecondaryColor	Gets or sets the secondary vehicle color of this player-textdraw's preview model.
	PreviewZoom	Gets or sets the zoom level of this player-textdraw's preview model.
	Proportional	Gets or sets whether to proporionally space the characters of this player-textdraw.
	Selectable	Gets or sets whether this player-textdraw is selectable.
	Shadow	Gets or sets the shadow-size of this player-textdraw.
	Text	Gets or sets the text of this player-textdraw.
	UseBox	Gets or sets whether to draw a box behind the player-textdraw.
	Width	Gets or sets the width of this player-textdraw's box.

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.)
	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 player-textdraw.
	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.)
	OnClick	Raises the Click event.
	Refresh	Recreates this player-textdraw with all set properties. Called when changing the location on the screen.
	Show	Displays this player-textdraw to the Owner of this textdraw.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Updates this textdraw on the client's screen.

Top

Events

	Name	Description
	Click	Occurs when the OnPlayerClickPlayerTextDraw(BasePlayer, ClickPlayerTextDrawEventArgs) is being called. This callback is called when a player clicks on a player-textdraw.
	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 player text draws which can exist.

Top

Reference

SampSharp.GameMode.Display Namespace