Class UIDrawTextElement

Defines a text element within UIDrawContent.

Index

Constructors

Properties

_color _depth? _font _fontSize _horizontalAlign _maximumWidth? _position _text _verticalAlign _wordWrap

Accessors

color depth font fontSize horizontalAlign maximumWidth position text verticalAlign wordWrap

Methods

assign clone isEqual isEqual

Constructors

constructor

new UIDrawTextElement(
    text?: string,
    font?: Font,
    fontSize?: number,
    color?: Immutable<SRGBColor>,
    position?: Immutable<rsx.UIPoint>,
    horizontalAlign?: EnumValue<TextHorizontalAlignType>,
    verticalAlign?: EnumValue<TextVerticalAlignType>,
    wordWrap?: boolean,
    maximumWidth?: number,
    depth?: number,
): UIDrawTextElement
Parameters
- Optionaltext: string
- Optionalfont: Font
- OptionalfontSize: number
- Optionalcolor: Immutable<SRGBColor>
- Optionalposition: Immutable<rsx.UIPoint>
- OptionalhorizontalAlign: EnumValue<TextHorizontalAlignType>
- OptionalverticalAlign: EnumValue<TextVerticalAlignType>
- OptionalwordWrap: boolean
- OptionalmaximumWidth: number
- Optionaldepth: number
Returns UIDrawTextElement

Properties

`Protected`_color

_color: SRGBColor

`Protected` `Optional`_depth

_depth?: number

`Protected`_font

_font: Font

`Protected`_fontSize

_fontSize: number

`Protected`_horizontalAlign

_horizontalAlign: EnumValue<TextHorizontalAlignType>

`Protected` `Optional`_maximumWidth

_maximumWidth?: number

`Protected`_position

_position: Vector2

`Protected`_text

_text: string

`Protected`_verticalAlign

_verticalAlign: EnumValue<TextVerticalAlignType>

`Protected`_wordWrap

_wordWrap: boolean

Accessors

color

get color(): SRGBColor

Text color.

Returns SRGBColor
set color(value: Immutable<SRGBColor>): void
Parameters
- value: Immutable<SRGBColor>
Returns void

depth

get depth(): number

Optional depth layer override. If unset, the default insertion-order depth is used.

Returns number
set depth(value: number): void
Parameters
- value: number
Returns void

font

get font(): Font

The font to use for rendering. If null, the default system font is used.

Returns Font
set font(value: Font): void
Parameters
- value: Font
Returns void

fontSize

get fontSize(): number

Font size in points.

Returns number
set fontSize(value: number): void
Parameters
- value: number
Returns void

horizontalAlign

get horizontalAlign(): EnumValue<TextHorizontalAlignType>

Horizontal text alignment.

Returns EnumValue<TextHorizontalAlignType>
set horizontalAlign(value: EnumValue<TextHorizontalAlignType>): void
Parameters
- value: EnumValue<TextHorizontalAlignType>
Returns void

maximumWidth

get maximumWidth(): number

Maximum width in points for text wrapping. Unset = no limit.

Returns number
set maximumWidth(value: number): void
Parameters
- value: number
Returns void

position

get position(): Vector2

Position in points (local coordinates).

Returns Vector2
set position(value: Immutable<rsx.UIPoint>): void
Parameters
- value: Immutable<rsx.UIPoint>
Returns void

text

get text(): string

The text string to display.

Returns string
set text(value: string): void
Parameters
- value: string
Returns void

verticalAlign

get verticalAlign(): EnumValue<TextVerticalAlignType>

Vertical text alignment.

Returns EnumValue<TextVerticalAlignType>
set verticalAlign(value: EnumValue<TextVerticalAlignType>): void
Parameters
- value: EnumValue<TextVerticalAlignType>
Returns void

wordWrap

get wordWrap(): boolean

Whether to wrap text at word boundaries.

Returns boolean
set wordWrap(value: boolean): void
Parameters
- value: boolean
Returns void

Methods

assign

assign(other: Immutable<UIDrawTextElement>): UIDrawTextElement
Copies all properties defined by the prototype of UIDrawTextElement from other to this instance.
Parameters
- other: Immutable<UIDrawTextElement>
Returns UIDrawTextElement

clone

clone(): UIDrawTextElement

Clones this instance and returns a new UIDrawTextElement with identical values.

Returns UIDrawTextElement

isEqual

isEqual(
this: Immutable<UIDrawTextElement>,
other: Immutable<UIDrawTextElement>,
): boolean
Determines if this UIDrawTextElement instance is equal to the other instance.
Parameters
- this: Immutable<UIDrawTextElement>
- other: Immutable<UIDrawTextElement>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<UIDrawTextElement>,
rhs: Immutable<UIDrawTextElement>,
): boolean
Determines if both UIDrawTextElement instances are equal.
Parameters
- lhs: Immutable<UIDrawTextElement>
- rhs: Immutable<UIDrawTextElement>
Returns boolean