Interface ITextDrawBase.IManagedInterface

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

Represents the managed interface implemented by its unmanaged counterpart.

public interface ITextDrawBase.IManagedInterface : IUnmanagedInterface

Inherited Members

IUnmanagedInterface.Handle

IUnmanagedInterface.HasValue

Methods

GetAlignment()

Gets the alignment of the textdraw's text.

TextDrawAlignmentTypes GetAlignment()

Returns

TextDrawAlignmentTypes

The current text alignment.

GetBackgroundColour()

Gets the background colour of the textdraw.

Colour GetBackgroundColour()

Returns

Colour

The background colour.

GetBoxColour()

Gets the colour of the textdraw's box.

Colour GetBoxColour()

Returns

Colour

The colour of the textdraw's box.

GetBoxColour(out Colour)

Gets the colour of the textdraw's box.

void GetBoxColour(out Colour colour)

Parameters

colour Colour

The box colour.

GetLetterColour()

Gets the colour of the textdraw's letters.

Colour GetLetterColour()

Returns

Colour

The colour of the textdraw's letters.

GetLetterSize()

Gets the size of the textdraw's letters.

Vector2 GetLetterSize()

Returns

Vector2

The size of the textdraw's letters.

GetOutline()

Gets the outline thickness of the textdraw.

int GetOutline()

Returns

int

The outline thickness.

GetPosition()

Gets the position of the textdraw.

Vector2 GetPosition()

Returns

Vector2

The position of the textdraw.

GetPreviewModel()

Gets the preview model for the textdraw.

int GetPreviewModel()

Returns

int

The model ID being previewed.

GetPreviewRotation()

Gets the preview rotation for the textdraw.

Vector3 GetPreviewRotation()

Returns

Vector3

The rotation vector.

GetPreviewVehicleColour()

Gets the preview vehicle colours for the textdraw.

(int, int) GetPreviewVehicleColour()

Returns

(int offset, int length)

A tuple containing the two vehicle colours.

GetPreviewZoom()

Gets the preview zoom factor for the textdraw.

float GetPreviewZoom()

Returns

float

The preview zoom factor.

GetShadow()

Gets the shadow strength of the textdraw.

int GetShadow()

Returns

int

The shadow strength.

GetStyle()

Gets the drawing style of the textdraw.

TextDrawStyle GetStyle()

Returns

TextDrawStyle

The drawing style.

GetText()

Gets the text of the textdraw.

string GetText()

Returns

string

The text currently displayed by the textdraw.

GetTextSize()

Gets the size of the textdraw area.

Vector2 GetTextSize()

Returns

Vector2

The size of the textdraw area.

HasBox()

Gets whether the textdraw uses a box.

bool HasBox()

Returns

bool

true if the textdraw uses a box; otherwise, false.

IsProportional()

Gets whether the textdraw is proportional.

bool IsProportional()

Returns

bool

true if the textdraw is proportional; otherwise, false.

IsSelectable()

Gets whether the textdraw is selectable.

bool IsSelectable()

Returns

bool

true if the textdraw is selectable; otherwise, false.

Restream()

Re-streams the textdraw to all players to which it is currently streamed in.

void Restream()

SetAlignment(TextDrawAlignmentTypes)

Sets the alignment of the textdraw's text.

ref ITextDrawBase SetAlignment(TextDrawAlignmentTypes alignment)

Parameters

alignment TextDrawAlignmentTypes

The alignment to set.

Returns

ITextDrawBase

This instance for chaining.

SetBackgroundColour(Colour)

Sets the background colour of the textdraw.

ref ITextDrawBase SetBackgroundColour(Colour colour)

Parameters

colour Colour

The new background colour.

Returns

ITextDrawBase

This instance for chaining.

SetBoxColour(Colour)

Sets the colour of the textdraw's box.

ref ITextDrawBase SetBoxColour(Colour colour)

Parameters

colour Colour

The new box colour.

Returns

ITextDrawBase

This instance for chaining.

SetColour(Colour)

Sets the colour of the textdraw's letters.

ref ITextDrawBase SetColour(Colour colour)

Parameters

colour Colour

The new letter colour.

Returns

ITextDrawBase

This instance for chaining.

SetLetterSize(Vector2)

Sets the size of the textdraw's letters.

ref ITextDrawBase SetLetterSize(Vector2 size)

Parameters

size Vector2

The new letter size.

Returns

ITextDrawBase

This instance for chaining.

SetOutline(int)

Sets the outline of the textdraw.

ref ITextDrawBase SetOutline(int outline)

Parameters

outline int

The outline thickness.

Returns

ITextDrawBase

This instance for chaining.

SetPosition(Vector2)

Sets the position of the textdraw.

ref ITextDrawBase SetPosition(Vector2 position)

Parameters

position Vector2

The new position of the textdraw.

Returns

ITextDrawBase

This instance for chaining.

SetPreviewModel(int)

Sets the preview model for the textdraw.

ref ITextDrawBase SetPreviewModel(int model)

Parameters

model int

The model ID to preview.

Returns

ITextDrawBase

This instance for chaining.

SetPreviewRotation(Vector3)

Sets the preview rotation for the textdraw.

ref ITextDrawBase SetPreviewRotation(Vector3 rotation)

Parameters

rotation Vector3

The rotation vector.

Returns

ITextDrawBase

This instance for chaining.

SetPreviewVehicleColour(int, int)

Sets the preview vehicle colours for the textdraw.

ref ITextDrawBase SetPreviewVehicleColour(int colour1, int colour2)

Parameters

colour1 int

The first vehicle colour.

colour2 int

The second vehicle colour.

Returns

ITextDrawBase

This instance for chaining.

SetPreviewZoom(float)

Sets the preview zoom factor for the textdraw.

ref ITextDrawBase SetPreviewZoom(float zoom)

Parameters

zoom float

The zoom factor.

Returns

ITextDrawBase

This instance for chaining.

SetProportional(bool)

Sets whether the textdraw is proportional.

ref ITextDrawBase SetProportional(bool proportional)

Parameters

proportional bool

Whether the textdraw is proportional. true for proportional, false otherwise.

Returns

ITextDrawBase

This instance for chaining.

SetSelectable(bool)

Sets whether the textdraw is selectable.

ref ITextDrawBase SetSelectable(bool selectable)

Parameters

selectable bool

Whether the textdraw is selectable. true for selectable, false otherwise.

Returns

ITextDrawBase

This instance for chaining.

SetShadow(int)

Sets the shadow strength of the textdraw.

ref ITextDrawBase SetShadow(int shadow)

Parameters

shadow int

The shadow strength.

Returns

ITextDrawBase

This instance for chaining.

SetStyle(TextDrawStyle)

Sets the drawing style of the textdraw.

ref ITextDrawBase SetStyle(TextDrawStyle style)

Parameters

style TextDrawStyle

The drawing style.

Returns

ITextDrawBase

This instance for chaining.

SetText(string)

Sets the text of the textdraw.

void SetText(string text)

Parameters

text string

The new text to display.

SetTextSize(Vector2)

Sets the size of the textdraw area.

ref ITextDrawBase SetTextSize(Vector2 size)

Parameters

size Vector2

The new textdraw area size.

Returns

ITextDrawBase

This instance for chaining.

UseBox(bool)

Sets whether the textdraw uses a box.

ref ITextDrawBase UseBox(bool use)

Parameters

use bool

Whether to use a box. true to use a box, false otherwise.

Returns

ITextDrawBase

This instance for chaining.