genshin-manager
    Preparing search index...

    Class Weapon

    Unified weapon class providing comprehensive access to all weapon data

    Index

    Constructors

    • Create a Weapon

      Parameters

      • weaponId: number

        weapon ID

      • level: number = 1

        weapon level (1-90). Default: 1

      • isAscended: boolean = true

        weapon is ascended. Default: true

      • refinementRank: number = 1

        weapon refinement rank (1-5). Default: 1

      Returns Weapon

    Properties

    id: number

    Weapon ID

    isAscended: boolean

    Weapon is ascended

    level: number

    Weapon level

    refinementRank: number

    Weapon refinement rank

    Accessors

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

      Weapon ascension materials

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

    • get description(): string

      Weapon description

      Returns string

    • get isAwaken(): boolean

      Whether the weapon is awakened

      Returns boolean

    • get isCanAscend(): boolean

      Check if weapon can ascend to next level

      Returns boolean

      true if weapon can ascend

    • get isCanRefine(): boolean

      Check if weapon can refine to next rank

      Returns boolean

      true if weapon can refine

    • get maxLevel(): number

      Weapon max level

      Returns number

    • get maxRefinementRank(): number

      Get max refinement rank for this weapon

      Returns number

      max refinement rank

    • get name(): string

      Weapon 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

      Weapon promote level

      Returns number

    • get rarity(): number

      Weapon rarity

      Returns number

    • get skillDescription(): undefined | string

      Weapon skill description

      Returns undefined | string

    • get skillName(): undefined | string

      Weapon skill name

      Returns undefined | string

    • get summary(): {
          level: string;
          name: string;
          rarity: number;
          refinement: string;
          type: WeaponType;
      }

      Get weapon summary information

      Returns {
          level: string;
          name: string;
          rarity: number;
          refinement: string;
          type: WeaponType;
      }

      weapon 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 allWeaponIds(): number[]

      Get all weapon IDs

      Returns number[]

      all weapon IDs

    Methods

    • Calculate weapon level upgrade materials

      Parameters

      • currentLevel: number

        current weapon level

      • targetLevel: number

        target weapon level

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

      array of materials needed

    • Get refinement effect for specified rank

      Parameters

      • Optionalrank: number

        refinement rank (1-5). Default: current rank

      Returns WeaponRefinement

      refinement effect

    • Get weapon ID by name

      Parameters

      • name: string

        weapon name

      Returns number[]

      weapon ID