Class Client

Class of the client

Description

This is the main body of Genshin-Manager where cache information is stored

Hierarchy

Constructors

constructor

Properties

option _assetEventEmitter _cachedTextMap

Accessors

gameVersion gameVersion

Methods

addListener changeLanguage deploy emit off on once removeAllListeners removeListener _addExcelBinOutputKeyFromClassPrototype _getCachedExcelBinOutputByName _getJsonFromCachedExcelBinOutput _hasCachedExcelBinOutputById _hasCachedExcelBinOutputByName _searchIdInExcelBinOutByText setExcelBinOutputToCache setTextMapToCache updateCache

Constructors

constructor

  • new Client(option?): Client

  • Create a Client

    Parameters

    Returns Client

Properties

Readonlyoption

option: ClientOption

Protected Static Readonly_assetEventEmitter

_assetEventEmitter: EventEmitter<AssetCacheManagerEventMap> = ...

Asset event emitter

Deprecated

This property is deprecated because it is used to pass data to each class

Static Readonly_cachedTextMap

_cachedTextMap: Map<string, string> = ...

Cached text map

Deprecated

This property is deprecated because it is used to pass data to each class

Key

Text hash

Value

Text

Accessors

gameVersion

  • get gameVersion(): undefined | string

  • Cached game version

    Returns undefined | string

    Cached game version

    Example

    `5.1.0`

Protected StaticgameVersion

  • get gameVersion(): undefined | string

  • Assets game version text

    Returns undefined | string

    Assets game version text or undefined

Methods

addListener

  • addListener<K>(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Type Parameters

    • K

    Parameters

    • eventName: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    • listener: K extends keyof ClientEventMap
          ? ClientEventMap[K<K>] extends unknown[]
              ? ((...args: ClientEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.addListener()

changeLanguage

  • changeLanguage(language): Promise<void>

  • Change cached languages

    Parameters

    • language:
          | "EN"
          | "RU"
          | "VI"
          | "TH"
          | "PT"
          | "KR"
          | "JP"
          | "ID"
          | "FR"
          | "ES"
          | "DE"
          | "CHT"
          | "CHS"

      Country code

    Returns Promise<void>

    Example

    const client = new Client()
    await client.deploy()
    await client.changeLanguage('JP')

deploy

  • deploy(): Promise<void>

  • Deploy assets to cache & Update assets

    Returns Promise<void>

    Example

    const client = new Client()
    await client.deploy()

Protectedemit

  • emit<K>(eventName, ...args): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each. Returns true if the event had listeners, false otherwise.

    Type Parameters

    • K

    Parameters

    • eventName: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    • Rest...args: K extends keyof ClientEventMap
          ? ClientEventMap[K<K>]
          : never

      Arguments to pass to the listeners.

    Returns boolean

    See

    EventEmitter.emit()

off

  • off<K>(eventName, listener): this

  • Alias for emitter.removeListener().

    Type Parameters

    • K

    Parameters

    • eventName: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    • listener: K extends keyof ClientEventMap
          ? ClientEventMap[K<K>] extends unknown[]
              ? ((...args: ClientEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.off()

on

  • on<K>(eventName, listener): this

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    Type Parameters

    • K

    Parameters

    • eventName: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    • listener: K extends keyof ClientEventMap
          ? ClientEventMap[K<K>] extends unknown[]
              ? ((...args: ClientEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.on()

once

  • once<K>(eventName, listener): this

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    Type Parameters

    • K

    Parameters

    • eventName: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    • listener: K extends keyof ClientEventMap
          ? ClientEventMap[K<K>] extends unknown[]
              ? ((...args: ClientEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.once()

removeAllListeners

  • removeAllListeners<K>(event?): this

  • Removes all listeners, or those of the specified eventName.

    Type Parameters

    • K

    Parameters

    • Optionalevent: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    Returns this

    See

    EventEmitter.removeAllListeners()

removeListener

  • removeListener<K>(eventName, listener): this

  • Removes the specified listener from the listener array for the event namedeventName.

    Type Parameters

    • K

    Parameters

    • eventName: ClientEvents | (keyof ClientEventMap) | K

      The name of the event.

    • listener: K extends keyof ClientEventMap
          ? ClientEventMap[K<K>] extends unknown[]
              ? ((...args: ClientEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.removeListener()

Static_addExcelBinOutputKeyFromClassPrototype

  • _addExcelBinOutputKeyFromClassPrototype(classPrototype): void

  • Add ExcelBinOutput Key from Class Prototype to AssetCacheManager

    Parameters

    • classPrototype: unknown

      Class Prototype

    Returns void

    Deprecated

    This method is deprecated because it is used to pass data to each class

Static_getCachedExcelBinOutputByName

  • _getCachedExcelBinOutputByName(key): {}

  • Get cached excel bin output by name

    Parameters

    • key:
          | "AnimalCodexExcelConfigData"
          | "AvatarCostumeExcelConfigData"
          | "AvatarCurveExcelConfigData"
          | "AvatarExcelConfigData"
          | "AvatarPromoteExcelConfigData"
          | "AvatarSkillDepotExcelConfigData"
          | "AvatarSkillExcelConfigData"
          | "AvatarTalentExcelConfigData"
          | "DungeonEntryExcelConfigData"
          | "DungeonLevelEntityConfigData"
          | "EquipAffixExcelConfigData"
          | "FetterInfoExcelConfigData"
          | "FettersExcelConfigData"
          | "FetterStoryExcelConfigData"
          | "ManualTextMapConfigData"
          | "MaterialExcelConfigData"
          | "MonsterCurveExcelConfigData"
          | "MonsterDescribeExcelConfigData"
          | "MonsterExcelConfigData"
          | "ProudSkillExcelConfigData"
          | "ProfilePictureExcelConfigData"
          | "ReliquaryAffixExcelConfigData"
          | "ReliquaryExcelConfigData"
          | "ReliquaryLevelExcelConfigData"
          | "ReliquaryMainPropExcelConfigData"
          | "ReliquarySetExcelConfigData"
          | "TowerFloorExcelConfigData"
          | "TowerLevelExcelConfigData"
          | "TowerScheduleExcelConfigData"
          | "WeaponCurveExcelConfigData"
          | "WeaponExcelConfigData"
          | "WeaponPromoteExcelConfigData"

      ExcelBinOutput name

    Returns {}

    Cached excel bin output

      Deprecated

      This method is deprecated because it is used to pass data to each class

    Static_getJsonFromCachedExcelBinOutput

    • _getJsonFromCachedExcelBinOutput(key, id): JsonObject

    • Get Json from cached excel bin output

      Parameters

      • key:
            | "AnimalCodexExcelConfigData"
            | "AvatarCostumeExcelConfigData"
            | "AvatarCurveExcelConfigData"
            | "AvatarExcelConfigData"
            | "AvatarPromoteExcelConfigData"
            | "AvatarSkillDepotExcelConfigData"
            | "AvatarSkillExcelConfigData"
            | "AvatarTalentExcelConfigData"
            | "DungeonEntryExcelConfigData"
            | "DungeonLevelEntityConfigData"
            | "EquipAffixExcelConfigData"
            | "FetterInfoExcelConfigData"
            | "FettersExcelConfigData"
            | "FetterStoryExcelConfigData"
            | "ManualTextMapConfigData"
            | "MaterialExcelConfigData"
            | "MonsterCurveExcelConfigData"
            | "MonsterDescribeExcelConfigData"
            | "MonsterExcelConfigData"
            | "ProudSkillExcelConfigData"
            | "ProfilePictureExcelConfigData"
            | "ReliquaryAffixExcelConfigData"
            | "ReliquaryExcelConfigData"
            | "ReliquaryLevelExcelConfigData"
            | "ReliquaryMainPropExcelConfigData"
            | "ReliquarySetExcelConfigData"
            | "TowerFloorExcelConfigData"
            | "TowerLevelExcelConfigData"
            | "TowerScheduleExcelConfigData"
            | "WeaponCurveExcelConfigData"
            | "WeaponExcelConfigData"
            | "WeaponPromoteExcelConfigData"

        ExcelBinOutput name

      • id: string | number

        ID of character, etc

      Returns JsonObject

      Json

      Deprecated

      This method is deprecated because it is used to pass data to each class

    Static_hasCachedExcelBinOutputById

    • _hasCachedExcelBinOutputById(key, id): boolean

    • Check if cached excel bin output exists by ID

      Parameters

      • key:
            | "AnimalCodexExcelConfigData"
            | "AvatarCostumeExcelConfigData"
            | "AvatarCurveExcelConfigData"
            | "AvatarExcelConfigData"
            | "AvatarPromoteExcelConfigData"
            | "AvatarSkillDepotExcelConfigData"
            | "AvatarSkillExcelConfigData"
            | "AvatarTalentExcelConfigData"
            | "DungeonEntryExcelConfigData"
            | "DungeonLevelEntityConfigData"
            | "EquipAffixExcelConfigData"
            | "FetterInfoExcelConfigData"
            | "FettersExcelConfigData"
            | "FetterStoryExcelConfigData"
            | "ManualTextMapConfigData"
            | "MaterialExcelConfigData"
            | "MonsterCurveExcelConfigData"
            | "MonsterDescribeExcelConfigData"
            | "MonsterExcelConfigData"
            | "ProudSkillExcelConfigData"
            | "ProfilePictureExcelConfigData"
            | "ReliquaryAffixExcelConfigData"
            | "ReliquaryExcelConfigData"
            | "ReliquaryLevelExcelConfigData"
            | "ReliquaryMainPropExcelConfigData"
            | "ReliquarySetExcelConfigData"
            | "TowerFloorExcelConfigData"
            | "TowerLevelExcelConfigData"
            | "TowerScheduleExcelConfigData"
            | "WeaponCurveExcelConfigData"
            | "WeaponExcelConfigData"
            | "WeaponPromoteExcelConfigData"

        ExcelBinOutput name

      • id: string | number

        ID of character, etc

      Returns boolean

      Cached excel bin output exists

      Deprecated

      This method is deprecated because it is used to pass data to each class

    Static_hasCachedExcelBinOutputByName

    • _hasCachedExcelBinOutputByName(key): boolean

    • Check if cached excel bin output exists by name

      Parameters

      • key:
            | "AnimalCodexExcelConfigData"
            | "AvatarCostumeExcelConfigData"
            | "AvatarCurveExcelConfigData"
            | "AvatarExcelConfigData"
            | "AvatarPromoteExcelConfigData"
            | "AvatarSkillDepotExcelConfigData"
            | "AvatarSkillExcelConfigData"
            | "AvatarTalentExcelConfigData"
            | "DungeonEntryExcelConfigData"
            | "DungeonLevelEntityConfigData"
            | "EquipAffixExcelConfigData"
            | "FetterInfoExcelConfigData"
            | "FettersExcelConfigData"
            | "FetterStoryExcelConfigData"
            | "ManualTextMapConfigData"
            | "MaterialExcelConfigData"
            | "MonsterCurveExcelConfigData"
            | "MonsterDescribeExcelConfigData"
            | "MonsterExcelConfigData"
            | "ProudSkillExcelConfigData"
            | "ProfilePictureExcelConfigData"
            | "ReliquaryAffixExcelConfigData"
            | "ReliquaryExcelConfigData"
            | "ReliquaryLevelExcelConfigData"
            | "ReliquaryMainPropExcelConfigData"
            | "ReliquarySetExcelConfigData"
            | "TowerFloorExcelConfigData"
            | "TowerLevelExcelConfigData"
            | "TowerScheduleExcelConfigData"
            | "WeaponCurveExcelConfigData"
            | "WeaponExcelConfigData"
            | "WeaponPromoteExcelConfigData"

        ExcelBinOutput name

      Returns boolean

      Cached excel bin output exists

      Deprecated

      This method is deprecated because it is used to pass data to each class

    Static_searchIdInExcelBinOutByText

    • _searchIdInExcelBinOutByText(key, text): string[]

    • Search ID in CachedExcelBinOutput by text

      Parameters

      • key:
            | "AnimalCodexExcelConfigData"
            | "AvatarCostumeExcelConfigData"
            | "AvatarCurveExcelConfigData"
            | "AvatarExcelConfigData"
            | "AvatarPromoteExcelConfigData"
            | "AvatarSkillDepotExcelConfigData"
            | "AvatarSkillExcelConfigData"
            | "AvatarTalentExcelConfigData"
            | "DungeonEntryExcelConfigData"
            | "DungeonLevelEntityConfigData"
            | "EquipAffixExcelConfigData"
            | "FetterInfoExcelConfigData"
            | "FettersExcelConfigData"
            | "FetterStoryExcelConfigData"
            | "ManualTextMapConfigData"
            | "MaterialExcelConfigData"
            | "MonsterCurveExcelConfigData"
            | "MonsterDescribeExcelConfigData"
            | "MonsterExcelConfigData"
            | "ProudSkillExcelConfigData"
            | "ProfilePictureExcelConfigData"
            | "ReliquaryAffixExcelConfigData"
            | "ReliquaryExcelConfigData"
            | "ReliquaryLevelExcelConfigData"
            | "ReliquaryMainPropExcelConfigData"
            | "ReliquarySetExcelConfigData"
            | "TowerFloorExcelConfigData"
            | "TowerLevelExcelConfigData"
            | "TowerScheduleExcelConfigData"
            | "WeaponCurveExcelConfigData"
            | "WeaponExcelConfigData"
            | "WeaponPromoteExcelConfigData"

        ExcelBinOutput name

      • text: string

        Text

      Returns string[]

      IDs

      Deprecated

      This method is deprecated because it is used to pass data to each class

    Protected StaticsetExcelBinOutputToCache

    • setExcelBinOutputToCache(keys): Promise<boolean>

    • Set excel bin output to cache

      Parameters

      • keys: Set<
            | "AnimalCodexExcelConfigData"
            | "AvatarCostumeExcelConfigData"
            | "AvatarCurveExcelConfigData"
            | "AvatarExcelConfigData"
            | "AvatarPromoteExcelConfigData"
            | "AvatarSkillDepotExcelConfigData"
            | "AvatarSkillExcelConfigData"
            | "AvatarTalentExcelConfigData"
            | "DungeonEntryExcelConfigData"
            | "DungeonLevelEntityConfigData"
            | "EquipAffixExcelConfigData"
            | "FetterInfoExcelConfigData"
            | "FettersExcelConfigData"
            | "FetterStoryExcelConfigData"
            | "ManualTextMapConfigData"
            | "MaterialExcelConfigData"
            | "MonsterCurveExcelConfigData"
            | "MonsterDescribeExcelConfigData"
            | "MonsterExcelConfigData"
            | "ProudSkillExcelConfigData"
            | "ProfilePictureExcelConfigData"
            | "ReliquaryAffixExcelConfigData"
            | "ReliquaryExcelConfigData"
            | "ReliquaryLevelExcelConfigData"
            | "ReliquaryMainPropExcelConfigData"
            | "ReliquarySetExcelConfigData"
            | "TowerFloorExcelConfigData"
            | "TowerLevelExcelConfigData"
            | "TowerScheduleExcelConfigData"
            | "WeaponCurveExcelConfigData"
            | "WeaponExcelConfigData"
            | "WeaponPromoteExcelConfigData">

        ExcelBinOutput names

      Returns Promise<boolean>

      Returns true if an error occurs

    Protected StaticsetTextMapToCache

    • setTextMapToCache(language): Promise<boolean>

    • Change cached languages

      Parameters

      • language:
            | "EN"
            | "RU"
            | "VI"
            | "TH"
            | "PT"
            | "KR"
            | "JP"
            | "ID"
            | "FR"
            | "ES"
            | "DE"
            | "CHT"
            | "CHS"

        Country code

      Returns Promise<boolean>

      Returns true if an error occurs

    Protected StaticupdateCache

    • updateCache(): Promise<void>

    • Update cache

      Returns Promise<void>

      Example

      await Client.updateCache()

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods