Class UIElementStateStyle

Specific texture and text color used in a particular UI element style.

Index

Constructors

Properties

_contentOffset _font _shape _textColor _texture _tintColor

Accessors

contentOffset font shape textColor texture tintColor

Methods

assign clone isEqual isEqual

Constructors

constructor

new UIElementStateStyle(
    texture?: Image,
    shape?: Shape,
    font?: Font,
    textColor?: Immutable<SRGBColor>,
    tintColor?: Immutable<SRGBColor>,
    contentOffset?: Immutable<RectOffset>,
): UIElementStateStyle
Parameters
- Optionaltexture: Image
- Optionalshape: Shape
- Optionalfont: Font
- OptionaltextColor: Immutable<SRGBColor>
- OptionaltintColor: Immutable<SRGBColor>
- OptionalcontentOffset: Immutable<RectOffset>
Returns UIElementStateStyle

Properties

`Protected`_contentOffset

_contentOffset: RectOffset

`Protected`_font

_font: Font

`Protected`_shape

_shape: Shape

`Protected`_textColor

_textColor: SRGBColor

`Protected`_texture

_texture: Image

`Protected`_tintColor

_tintColor: SRGBColor

Accessors

contentOffset

get contentOffset(): RectOffset

Additional offset to the content, that doesn't effect the bounds. Controls like UIButton use this value to apply an offset to it's icon and text when the button is in active state.

Returns RectOffset
set contentOffset(value: Immutable<RectOffset>): void
Parameters
- value: Immutable<RectOffset>
Returns void

font

get font(): Font

Font to use for all text within the UI element when this state state. If empty, default style font is used.

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

shape

get shape(): Shape

Returns Shape
set shape(value: Shape): void
Parameters
- value: Shape
Returns void

textColor

get textColor(): SRGBColor

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

texture

get texture(): Image

Returns Image
set texture(value: Image): void
Parameters
- value: Image
Returns void

tintColor

get tintColor(): SRGBColor

A tint color that will be used by the element.

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

Methods

assign

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

clone

clone(): UIElementStateStyle

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

Returns UIElementStateStyle

isEqual

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

`Static`isEqual

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