@gw2api/types/data/trait.ts

TypeScript types for all datastructures used by the Guild Wars 2 API

import type { Skill, SkillFact, SkillFactTraited } from './skill';

/**
 * Trait as returned by `/v2/traits`
 * @see https://wiki.guildwars2.com/wiki/API:2/traits
 */
export interface Trait {
  /** The trait id */
  id: number,

  /** The name of the trait */
  name: string,

  /** The icon of the trait */
  icon: string,

  /** The trait description */
  description?: string,

  /** The id of the specialization this trait belongs to */
  specialization: number,

  /** The tier (Adept/Master/Grandmaster) of this trait */
  tier: Trait.Tier,

  /** The order (top to bottom) of major traits */
  order: Trait.Order,

  /** The slot of this trait */
  slot: Trait.Slot,

  /** The trait facts */
  facts?: SkillFact[],

  /** The trait facts only active when other traits are active */
  traited_facts?: SkillFactTraited[],

  // TODO: Use Pick<Skill, ???> instead of full skill interface
  /** The skills triggered by this trait */
  skills?: Skill[],
}

export namespace Trait {
  export type Tier = 0 | 1 | 2;
  export type Order = 0 | 1 | 2;
  export type Slot = 'Major' | 'Minor';
}