RSX Code Reference
    Preparing search index...
    • rsx
    • StringTable

    Class StringTable

    Used for string localization. Stores strings and their translations in various languages.

    Hierarchy (View Summary)

    Index
    constructor
    handle identifiers isDestroyed metaData name numStrings uuid
    contains duplicate getString onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart removeString revert setString unload
    • get identifiers(): Iterable<string>

      Returns all identifiers that the string table contains localized strings for.

      Returns Iterable<string>

    • 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 numStrings(): number

      Returns a total number of strings in the table.

      Returns number

    • get uuid(): UUID

      Returns a universally unique identifier of this resource.

      Returns UUID

    • Checks does the string table contain the provided identifier.

      Parameters

      • identifier: string

        Identifier to look for.

      Returns boolean

      True if the identifier exists in the table, false otherwise.

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

      Returns Resource

      The duplicated resource or null, if the duplication failed.

    • Returns a string translation for the specified language. Returns the identifier itself if one doesn't exist.

      Parameters

      Returns string

    • 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 the string described by identifier, from all languages.

      Parameters

      • identifier: 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.

    • Adds or modifies string translation for the specified language.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods