Class Weapon

constructor

• new Weapon(
      weaponId: number,
      level?: number,
      isAscended?: boolean,
      refinementRank?: number,
  ): Weapon

  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

Readonlyid

ReadonlyisAscended

Readonlylevel

ReadonlyrefinementRank

ascensionMaterials

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

  Weapon ascension materials

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

description

• get description(): string

  Weapon description

  Returns string

icon

• get icon(): ImageAssets

  Weapon icon

  Returns ImageAssets

isAwaken

• get isAwaken(): boolean

  Whether the weapon is awakened

  Returns boolean

isCanAscend

• get isCanAscend(): boolean

  Check if weapon can ascend to next level

  Returns boolean

  true if weapon can ascend

isCanRefine

• get isCanRefine(): boolean

  Check if weapon can refine to next rank

  Returns boolean

  true if weapon can refine

maxLevel

• get maxLevel(): number

  Weapon max level

  Returns number

maxRefinementRank

• get maxRefinementRank(): number

  Get max refinement rank for this weapon

  Returns number

  max refinement rank

name

• get name(): string

  Weapon name

  Returns string

nextAscensionMaterials

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

  Get required materials for next ascension

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

  array of materials needed for next ascension

promoteLevel

• get promoteLevel(): number

  Weapon promote level

  Returns number

rarity

• get rarity(): number

  Weapon rarity

  Returns number

refinementAddProps

• get refinementAddProps(): StatProperty[]

  Weapon refinement effects

  Returns StatProperty[]

skillDescription

• get skillDescription(): undefined | string

  Weapon skill description

  Returns undefined | string

skillName

• get skillName(): undefined | string

  Weapon skill name

  Returns undefined | string

stats

• get stats(): StatProperty[]

  Calculated weapon stats

  Returns StatProperty[]

summary

• 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

totalAscensionMaterials

• 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

type

• get type(): WeaponType

  Weapon type

  Returns WeaponType

StaticallWeaponIds

• get allWeaponIds(): number[]

  Get all weapon IDs

  Returns number[]

  all weapon IDs

calculateWeaponLevelMaterials

• calculateWeaponLevelMaterials(
      currentLevel: number,
      targetLevel: number,
  ): { count: number; id: number }[]

  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

getRefinementEffect

• getRefinementEffect(rank?: number): WeaponRefinement

  Get refinement effect for specified rank

  Parameters

  • Optionalrank: number

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

  Returns WeaponRefinement

  refinement effect

StaticgetWeaponIdByName

• getWeaponIdByName(name: string): number[]

  Get weapon ID by name

  Parameters

  • name: string

    weapon name

  Returns number[]

  weapon ID