Interface ITextLabelBase.IManagedInterface

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

Represents the managed interface implemented by its unmanaged counterpart.

public interface ITextLabelBase.IManagedInterface : IUnmanagedInterface

Inherited Members

IUnmanagedInterface.Handle

IUnmanagedInterface.HasValue

Methods

AttachToPlayer(IPlayer, Vector3)

Attaches the text label to a player.

void AttachToPlayer(IPlayer player, Vector3 offset)

Parameters

player IPlayer

The player to attach the text label to.

offset Vector3

The offset from the player's position.

AttachToVehicle(IVehicle, Vector3)

Attaches the text label to a vehicle.

void AttachToVehicle(IVehicle vehicle, Vector3 offset)

Parameters

vehicle IVehicle

The vehicle to attach the text label to.

offset Vector3

The offset from the vehicle's position.

DetachFromPlayer(Vector3)

Detaches the text label from the player it was attached to.

void DetachFromPlayer(Vector3 position)

Parameters

position Vector3

The new position for the text label after detachment.

DetachFromVehicle(Vector3)

Detaches the text label from the vehicle it was attached to.

void DetachFromVehicle(Vector3 position)

Parameters

position Vector3

The new position for the text label after detachment.

GetAttachmentData()

Gets the attachment data of the text label.

ref TextLabelAttachmentData GetAttachmentData()

Returns

TextLabelAttachmentData

A reference to the TextLabelAttachmentData structure containing the attachment information.

GetColour()

Gets the colour of the text label.

Colour GetColour()

Returns

Colour

The colour of the text label.

GetColour(out Colour)

Gets the colour of the text label.

void GetColour(out Colour colour)

Parameters

colour Colour

When the method returns, contains the colour of the text label.

GetDrawDistance()

Gets the draw distance of the text label.

float GetDrawDistance()

Returns

float

The draw distance in units.

GetTestLOS()

Gets whether line-of-sight testing is enabled for the text label.

bool GetTestLOS()

Returns

bool

true if line-of-sight testing is enabled; otherwise, false.

GetText()

Gets the text content of the text label.

string GetText()

Returns

string

The text currently displayed on the text label.

SetColour(Colour)

Sets the colour of the text label.

void SetColour(Colour colour)

Parameters

colour Colour

The colour to set.

SetColourAndText(Colour, string)

Sets both the colour and text of the text label in a single operation.

void SetColourAndText(Colour colour, string text)

Parameters

colour Colour

The colour to set.

text string

The text to set.

SetDrawDistance(float)

Sets the draw distance for the text label.

void SetDrawDistance(float dist)

Parameters

dist float

The draw distance in units.

SetTestLOS(bool)

Sets whether line-of-sight testing is enabled for the text label.

void SetTestLOS(bool status)

Parameters

status bool

true to enable line-of-sight testing; false to disable it.

SetText(string)

Sets the text content of the text label.

void SetText(string text)

Parameters

text string

The new text to display.