RSX Code Reference
    Preparing search index...

    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 Summary)

    Index
    constructor
    handle isDestroyed metaData name styleNames uuid
    duplicate getColor getFloat getStyle hasStyle onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart removeStyle revert setStyle unload

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

      Parameters

      • OptionalisInternalConstructor: boolean

      Returns UISkin

    • get isDestroyed(): boolean

      Determines if the resource is destroyed.

      Returns boolean

      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.

    • get name(): string

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

      Returns string

    • get styleNames(): Iterable<string>

      Returns names of all styles registered on this skin.

      Returns Iterable<string>

    • get uuid(): UUID

      Returns a universally unique identifier of this resource.

      Returns UUID

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

      Returns Resource

      The duplicated resource or null, if the duplication failed.

    • Returns the float variable with the specified name, or the default value if the variable is not defined.

      Parameters

      • name: string
      • defaultValue: number

      Returns number

    • Returns a style for the specified UI element type.

      Parameters

      • uiElemType: string

      Returns UIElementStyle

    • Checks if the style with the specified name exists.

      Parameters

      • name: string

      Returns boolean

    • Virtual

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

      Returns void

    • Virtual

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

      Returns void

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

    • Virtual

      Method called by RSX to disable the resource.

      Returns void

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

    • Virtual

      Method called by RSX to enable the resource.

      Returns void

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

    • Virtual

      Method called by RSX to perform initialization of the resource.

      Returns void

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

    • Virtual

      Method called by RSX to perform any operations before serialization.

      Returns void

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

    • Removes a style for the specified UI element type.

      Parameters

      • uiElemType: string

      Returns void

    • Reverts the resource to the on-disk representation.

      Returns boolean

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

    • Sets a style for the specified UI element type.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods