Class UISkin

Holds a set of styles that control how are UI element types positioned and displayed in the UI. Each element type can be assigned a specific style.

Hierarchy (view full)

Constructors

constructor

Accessors

handle isDestroyed metaData name styleNames uuid

Methods

duplicate getStyle hasStyle onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart removeStyle revert setStyle unload

Constructors

constructor

  • new UISkin(isInternalConstructor?): UISkin

  • Creates an empty UI skin and returns a handle to it.

    Parameters

    • OptionalisInternalConstructor: boolean

    Returns UISkin

Accessors

handle

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

styleNames

  • get styleNames(): Iterable<string>

  • Returns names of all styles registered on this skin.

    Returns Iterable<string>

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

getStyle

hasStyle

  • hasStyle(name): boolean

  • Checks if the style with the specified name exists.

    Parameters

    • name: string

    Returns boolean

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

removeStyle

  • removeStyle(uiElemType): void

  • Removes a style for the specified UI element type.

    Parameters

    • uiElemType: string

    Returns void

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

setStyle

  • setStyle(uiElemType, style): void

  • Sets a style for the specified UI element type.

    Parameters

    Returns void

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods