Interface LangString

Interface representing a localiced string. Corresponds to the LangTextVar class in the C++ API.

interface LangString {
    get allTexts(): string[];
    getText(langIdx?: number): string;
    getTextByGlobalId(globalId: number): string;
    setAllText(text: string): void;
    setText(langIdx: number, text: string): void;
    setTextByGlobalId(globalId: number, text: string): void;
    toObject(): object;
}

Index

Accessors

Methods

getText getTextByGlobalId setAllText setText setTextByGlobalId toObject

Accessors

allTexts

get allTexts(): string[]
All texts for all languages as array of texts.

Returns string[]

Methods

getText

getText(langIdx?: number): string
Gets the text for the specified language index.
Parameters
- OptionallangIdx: number
  The language index.
Returns string
The text for the specified language index.

getTextByGlobalId

getTextByGlobalId(globalId: number): string
Gets the text for the specified global ID.
Parameters
- globalId: number
  The global ID.
Returns string
The text for the specified global ID.

setAllText

setAllText(text: string): void
Sets the text for all languages.
Parameters
- text: string
  The text to set.
Returns void

setText

setText(langIdx: number, text: string): void
Sets the text for the specified language index.
Parameters
- langIdx: number
  The language index.
- text: string
  The text to set.
Returns void

setTextByGlobalId

setTextByGlobalId(globalId: number, text: string): void
Sets the text for the specified global ID.
Parameters
- globalId: number
  The global ID.
- text: string
  The text to set.
Returns void

toObject

toObject(): object
Converts the LangString to an object.

Returns object
The object representation of the LangString.