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?, font?, fontSize?, color?, position?, horizontalAlign?, verticalAlign?, wordWrap?, maximumWidth?, depth?): UIDrawTextElement
Parameters
- Optionaltext: string
- Optionalfont: Font
- OptionalfontSize: number
- Optionalcolor: Immutable<SRGBColor>
- Optionalposition: Immutable<Vector2>
- OptionalhorizontalAlign: EnumValue<TextHorizontalAlignType, number>
- OptionalverticalAlign: EnumValue<TextVerticalAlignType, number>
- 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, number>

`Protected` `Optional`_maximumWidth

_maximumWidth?: number

`Protected`_position

_position: Vector2

`Protected`_text

_text: string

`Protected`_verticalAlign

_verticalAlign: EnumValue<TextVerticalAlignType, number>

`Protected`_wordWrap

_wordWrap: boolean

Accessors

color

get color(): SRGBColor
Text color.

Returns SRGBColor
set color(value): 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): 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): void
Parameters
- value: Font
Returns void

fontSize

get fontSize(): number
Font size in points.

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

horizontalAlign

get horizontalAlign(): EnumValue<TextHorizontalAlignType, number>
Horizontal text alignment.

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

maximumWidth

get maximumWidth(): number
Maximum width in points for text wrapping. Unset = no limit.

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

position

get position(): Vector2
Position in points (local coordinates).

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

text

get text(): string
The text string to display.

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

verticalAlign

get verticalAlign(): EnumValue<TextVerticalAlignType, number>
Vertical text alignment.

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

wordWrap

get wordWrap(): boolean
Whether to wrap text at word boundaries.

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

Methods

assign

assign(other): 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, other): 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, rhs): boolean
Determines if both UIDrawTextElement instances are equal.
Parameters
- lhs: Immutable<UIDrawTextElement>
- rhs: Immutable<UIDrawTextElement>
Returns boolean