genshin-manager
    Preparing search index...

    Class Character

    Unified character class providing comprehensive access to all character data

    Index

    Constructors

    • Create a Character

      Parameters

      • characterId: number

        character ID

      • level: number = 1

        character level (1-90). Default: 1

      • isAscended: boolean = false

        character is ascended (true or false). Default: false

      • constellationLevel: number = 0

        constellation level (0-6). Default: 0

      • OptionalskillDepotId: number

        skill depot ID (for travelers). Optional

      Returns Character

    Properties

    constellationLevel: number

    Constellation level (0-6)

    id: number

    Character ID

    isAscended: boolean

    Character is ascended

    level: number

    Character level

    Accessors

    • get ascensionMaterials(): { count: number; id: number }[]

      Character ascension materials

      Returns { count: number; id: number }[]

    • get constellationIds(): number[]

      Constellation IDs

      Returns number[]

    • get defaultCostumeId(): number

      Default costume ID

      Returns number

    • get depotId(): number

      Skill depot ID

      Returns number

    • get element(): undefined | Element

      Element of the character

      Returns undefined | Element

    • get inherentSkillOrder(): number[]

      Inherent skill order

      Returns number[]

    • get isCanAscend(): boolean

      Check if character can ascend to next level

      Returns boolean

      true if character can ascend

    • get maxLevel(): number

      Character max level

      Returns number

    • get name(): string

      Character name

      Returns string

    • get nextAscensionMaterials(): { count: number; id: number }[]

      Get required materials for next ascension

      Returns { count: number; id: number }[]

      array of materials needed for next ascension

    • get promoteLevel(): number

      Character promote level

      Returns number

    • get proudMap(): Map<number, number>

      Map of skill ID and proud ID

      Returns Map<number, number>

    • get rarity(): number

      Character rarity

      Returns number

    • get skillOrder(): number[]

      Skill order

      Returns number[]

    • get summary(): {
          constellation: string;
          element: undefined
          | Element;
          level: string;
          name: string;
          rarity: number;
          weapon: WeaponType;
      }

      Get character summary information

      Returns {
          constellation: string;
          element: undefined | Element;
          level: string;
          name: string;
          rarity: number;
          weapon: WeaponType;
      }

      character summary object

    • get totalAscensionMaterials(): { count: number; id: number }[]

      Get total materials needed from current to max level

      Returns { count: number; id: number }[]

      array of total materials needed

    • get allCharacterIds(): number[]

      Get all character IDs

      Returns number[]

      all character IDs

    Methods

    • Calculate total materials needed for character upgrade plan

      Parameters

      • plan: CharacterUpgradePlan

        character upgrade plan specifying level and skill changes

      Returns { count: number; id: number }[]

      array of total materials needed

    • Get elemental burst

      Parameters

      • skillLevel: number = 1

        skill level (1-15). Default: 1

      Returns CharacterSkill

      elemental burst

    • Get elemental burst upgrade materials for a specific level

      Parameters

      • skillLevel: number

        skill level (1-15)

      Returns { count: number; id: number }[]

      array of materials needed

    • Get elemental skill

      Parameters

      • skillLevel: number = 1

        skill level (1-15). Default: 1

      Returns CharacterSkill

      elemental skill

    • Get elemental skill upgrade materials for a specific level

      Parameters

      • skillLevel: number

        skill level (1-15)

      Returns { count: number; id: number }[]

      array of materials needed

    • Get normal attack skill

      Parameters

      • skillLevel: number = 1

        skill level (1-15). Default: 1

      Returns CharacterSkill

      normal attack skill

    • Get normal attack upgrade materials for a specific level

      Parameters

      • skillLevel: number

        skill level (1-15)

      Returns { count: number; id: number }[]

      array of materials needed

    • Get character ID by name

      Parameters

      • name: string

        character name

      Returns number[]

      character ID

    • Get traveler skill depot IDs

      Parameters

      • characterId: number

        character ID

      Returns number[]

      skill depot IDs