Class StringTable

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

Hierarchy (view full)

Constructors

constructor

Accessors

handle identifiers isDestroyed metaData name numStrings uuid

Methods

contains duplicate getString onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart removeString revert setString unload

Constructors

constructor

Accessors

handle

identifiers

  • get identifiers(): Iterable<string>

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

    Returns Iterable<string>

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

numStrings

  • get numStrings(): number

  • Returns a total number of strings in the table.

    Returns number

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

contains

  • contains(identifier): boolean

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

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.

getString

  • getString(identifier, language): string

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

    Parameters

    Returns string

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.

removeString

  • removeString(identifier): void

  • Removes the string described by identifier, from all languages.

    Parameters

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

setString

  • setString(identifier, language, value): void

  • Adds or modifies string translation for the specified language.

    Parameters

    Returns void

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods