TextAssets

Hierarchy

• TextAssets
  • DynamicTextAssets

Index

Constructors

• constructor

Properties

• client
• id

Methods

• get
• getAsFormattedText
• getAsNullableFormattedText
• getNullable
• isFormatted
• toString

Constructors

constructor

• new TextAssets(id: number, client: StarRail): TextAssets

• Parameters

  • id: number

  • client: StarRail

  Returns TextAssets

Properties

readonlyclient

client: StarRail

readonlyid

id: number

Methods

get

• get(lang?: LanguageCode): string

• @throws

  ---

  Parameters

  • optionallang: LanguageCode

  Returns string

getAsFormattedText

• getAsFormattedText(lang?: LanguageCode): FormattedText

• Parameters

  • optionallang: LanguageCode

  Returns FormattedText

getAsNullableFormattedText

• getAsNullableFormattedText(lang?: LanguageCode): null | FormattedText

• ---

  Parameters

  • optionallang: LanguageCode

  Returns null | FormattedText

  null instead of throwing AssetsNotFoundError.

getNullable

• getNullable(lang?: LanguageCode): null | string

• ---

  Parameters

  • optionallang: LanguageCode

  Returns null | string

  null instead of throwing AssetsNotFoundError.

isFormatted

• isFormatted(lang?: LanguageCode): boolean

• ---

  Parameters

  • optionallang: LanguageCode

  Returns boolean

  whether the text is formatted or not.

toString

• toString(): string

• Returns string