Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

AbilityListMatch

AbilityListMatch: object

Type declaration

AbilityListOptions

AbilityListOptions: object

Type declaration

AiParams

AiParams: object

Type declaration

  • preferredEnemyTargetingRuleId: string
  • preferredTargetAllyTargetingRuleId: string
  • requireAllyTargets: boolean
  • requireEnemyPreferredTargets: boolean

Arena

Arena: object

Arena properties

Type declaration

BaseItem

BaseItem: object

Type declaration

  • id: string
  • maxQuantity: number
  • minQuantity: number
  • rarity: number
  • statMod: undefined
  • type: number
  • weight: number

BaseMod

BaseMod: object

Bare Mod properties

Type declaration

  • id: string
  • level: number
  • pips: number
  • set: number
  • tier: number

BaseUnit

BaseUnit: object

Bare Units properties

Type declaration

  • defId: string
  • id: string
  • type: number

BattlesOptions

BattlesOptions: object

Optional projection of BattlesResponse properties (first layer) you want returned

Type declaration

  • Optional campaignMapList?: boolean
  • Optional campaignType?: boolean
  • Optional descriptionKey?: boolean
  • Optional id?: boolean
  • Optional nameKey?: boolean

CampaignMap

CampaignMap: object

CampaignMap properties

Type declaration

  • campaignNodeDifficultyGroupList: CampaignNodeDifficultyGroup[]
  • entryOwnershipRequirementList: object[]
  • id: string
  • unlockRequirementLocalizationKey: string

CampaignNode

CampaignNode: object

Type declaration

CampaignNodeDifficultyGroup

CampaignNodeDifficultyGroup: object

Type declaration

  • campaignNodeDifficulty: number
  • campaignNodeList: CampaignNode
  • unlockRequirementLocalizationKey: string

CampaignNodeMission

CampaignNodeMission: object

Type declaration

  • combatType: number
  • descKey: string
  • enemyUnitPreviewList: EnemyUnit[]
  • firstCompleteRewardPreviewList: BaseItem[]
  • groupNameKey: string
  • id: string
  • nameKey: string
  • rewardPreviewList: BaseItem[]
  • shortNameKey: string

CommonRequest

CommonRequest: object

Common properties for all Request interfaces

Type declaration

  • Optional enums?: boolean

    Optionally return enumerated items as their string equivalents

  • Optional language?: Languages

    Optional language to return translated names If no language specified, no translations will be applied

Crew

Crew: object

Crew properties

Type declaration

  • cp: number
  • gp: number
  • skillReferenceList: string[]
  • slot: number
  • unitId: string

EffectReference

EffectReference: object

Type declaration

  • contextIndexList: number[]
  • id: string
  • maxBonusMove: number

EnemyUnit

EnemyUnit: object

Type declaration

  • baseEnemyItem: BaseItem
  • displayedEnemy: boolean
  • enemyLevel: number
  • enemyTier: number
  • prefabName: string
  • threatLevel: number
  • thumbnailName: string
  • unitClass: number

Equipped

Equipped: object

Equipped properties for Roster units

Type declaration

  • equipmentId: string
  • slot: number

EventsInstance

EventsInstance: object

Event instance properties

Type declaration

  • displayEndTime: number
  • displayStartTime: number
  • endTime: number
  • rewardTime: number
  • startTime: number

EventsOptions

EventsOptions: object

Optional projection of EventsdResponse properties (first layer) you want returned

Type declaration

  • Optional defensiveSquadType?: boolean
  • Optional descKey?: boolean
  • Optional id?: boolean
  • Optional instances?: boolean
  • Optional nameKey?: boolean
  • Optional priority?: boolean
  • Optional squadType?: boolean
  • Optional summaryKey?: boolean

GuildOptions

GuildOptions: object

Optional projection of GuildResponse properties (first layer) you want returned

Type declaration

  • Optional banerLogo?: boolean
  • Optional bannerColor?: boolean
  • Optional desc?: boolean
  • Optional gp?: boolean
  • Optional members?: boolean
  • Optional message?: boolean
  • Optional name?: boolean
  • Optional raid?: boolean
  • Optional required?: boolean
  • Optional roster?: boolean
  • Optional status?: boolean
  • Optional updated?: boolean

LoginResponse

LoginResponse: object

Response from successful login

Type declaration

  • access_token: string
  • expires_in: string

PlayerOptions

PlayerOptions: object

Optional projection of PlayerResponse properties (first layer) you want returned

Type declaration

  • Optional allyCode?: boolean
  • Optional arena?: boolean
  • Optional guildName?: boolean
  • Optional level?: boolean
  • Optional name?: boolean
  • Optional roster?: boolean
  • Optional stats?: boolean
  • Optional updated?: boolean

Skills

Skills: object

Skills properties for Roster units

Type declaration

  • id: string
  • isZeta: boolean
  • tier: number

Stats

Stats: object

Player stats

Type declaration

  • index: number
  • nameKey: string
  • value: number

Tier

Tier: object

Type declaration

  • cooldownMaxOverride: number
  • descKey: string
  • effectReferenceList: EffectReference[]
  • interactsWithTagList: object[]
  • upgradeDescKey: string

UnitsInstance

UnitsInstance: object

Response from UnitsRequest

Type declaration

  • Optional allyCode?: number
  • Optional gear?: string[]
  • Optional gearLevel?: number
  • Optional gp?: number
  • Optional level?: number
  • Optional mods?: ModInstance[]
  • Optional player?: string
  • Optional starLevel?: number
  • Optional type?: number
  • Optional updated?: number
  • Optional zetas?: string[]

UnitsOptions

UnitsOptions: object

Optional projection of UnitsdResponse properties (first layer) you want returned

Type declaration

  • Optional allyCode?: boolean
  • Optional gear?: boolean
  • Optional gearLevel?: boolean
  • Optional gp?: boolean
  • Optional level?: boolean
  • Optional mods?: boolean
  • Optional player?: boolean
  • Optional starLevel?: boolean
  • Optional type?: boolean
  • Optional updated?: boolean
  • Optional zetas?: boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc