DynamicTextAssets

Hierarchy

• TextAssets
  • DynamicTextAssets
    • SkillAttributeAssets

Index

Constructors

• constructor

Properties

• convertToHtmlFormat
• directory
• dynamicData
• enka
• id

Methods

• copyWithUserInfo
• get
• getNullable
• getNullableReplacedData
• getNullableReplacedText
• getReplacedData
• getReplacedText
• setConvertToHtmlFormat
• toString

Constructors

constructor

• new DynamicTextAssets(id: number, data: Partial<DynamicData>, enka: EnkaClient, convertToHtmlFormat?: boolean, directory?: string): DynamicTextAssets

• Overrides TextAssets.constructor

  Parameters

  • id: number

  • data: Partial<DynamicData>

  • enka: EnkaClient

  • convertToHtmlFormat: boolean = false

  • optionaldirectory: string

  Returns DynamicTextAssets

Properties

convertToHtmlFormat

convertToHtmlFormat: boolean

Inherited from TextAssets.convertToHtmlFormat

readonlydirectory

directory: null | string

Inherited from TextAssets.directory

readonlydynamicData

dynamicData: DynamicData

readonlyenka

enka: EnkaClient

Inherited from TextAssets.enka

readonlyid

id: number

Inherited from TextAssets.id

Methods

copyWithUserInfo

• copyWithUserInfo(userInfo: UserInfo): DynamicTextAssets

• ---

  Parameters

  • userInfo: UserInfo

  Returns DynamicTextAssets

  new instance of DynamicTextAssets with provided userInfo.

get

• get(lang?: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): string

• Inherited from TextAssets.get

  @throws

  ---

  Parameters

  • optionallang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

  Returns string

getNullable

• getNullable(lang?: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): null | string

• Inherited from TextAssets.getNullable

  ---

  Parameters

  • optionallang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

  Returns null | string

  null instead of throwing AssetsNotFoundError.

getNullableReplacedData

• getNullableReplacedData(replaceWith?: keyof DynamicData[], lang?: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): null | { text: string; usedParamIndices: number[] }

• ---

  Parameters

  • replaceWith: keyof DynamicData[] = []

  • optionallang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

  Returns null | { text: string; usedParamIndices: number[] }

  null instead of throwing AssetsNotFoundError.

getNullableReplacedText

• getNullableReplacedText(replaceWith?: keyof DynamicData[], lang?: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): null | string

• ---

  Parameters

  • replaceWith: keyof DynamicData[] = []

  • optionallang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

  Returns null | string

  null instead of throwing AssetsNotFoundError.

getReplacedData

• getReplacedData(replaceWith?: (paramList | userInfo | userInfo.travelerGender | userInfo.travelerNickname | userInfo.platform)[], lang?: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): { text: string; usedParamIndices: number[] }

• @throws

  AssetsNotFoundError

  ---

  Parameters

  • replaceWith: (paramList | userInfo | userInfo.travelerGender | userInfo.travelerNickname | userInfo.platform)[] = []

    an empty array is the same as an array containing all paths

  • optionallang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

  Returns { text: string; usedParamIndices: number[] }

  • text: string

  • usedParamIndices: number[]

getReplacedText

• getReplacedText(replaceWith?: keyof DynamicData[], lang?: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): string

• @throws

  AssetsNotFoundError

  ---

  Parameters

  • replaceWith: keyof DynamicData[] = []

  • optionallang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

  Returns string

setConvertToHtmlFormat

• setConvertToHtmlFormat(convertToHtmlFormat: boolean): this

• Inherited from TextAssets.setConvertToHtmlFormat

  Parameters

  • convertToHtmlFormat: boolean

  Returns this

toString

• toString(): string

• Inherited from TextAssets.toString

  Returns string