@my-swu/simulator-client

---

@my-swu/simulator-client / ActiveEffectDescriptionView

Type Alias: ActiveEffectDescriptionView

ActiveEffectDescriptionView = { hp: number; power: number; type: "stats"; } | { hp?: number | null; power?: number | null; type: "printedStats"; } | { keyword: string; type: "keyword"; value: number; } | { keyword: string; type: "loseKeyword"; } | { granted: boolean; traitName: string; type: "trait"; } | { type: "abilityGrant"; } | { effect?: DelayedEffectDescriptionView | null; trigger: TriggerWindowView; type: "triggerGrant"; } | { effect?: DelayedEffectDescriptionView | null; type: "bountyGrant"; } | { count: number; type: "whenPlayedReplay"; } | { type: "combatDamageEqualsRemainingHp"; } | { type: "entersReady"; } | { amount: number; scope: EffectCardScopeView; type: "costModifier"; uses?: number | null; } | { scope: EffectCardScopeView; type: "aspectPenaltyIgnore"; } | { restriction: EffectRestrictionView; type: "restriction"; } | { amount?: number | null; effect: NamedCardEffectDescriptionView; name: string; type: "namedCard"; } | { amount?: number | null; combatOnly: boolean; type: "damagePrevention"; } | { type: "redirectDamage"; unitId: number; } | { controller: Seat; owner: Seat; resource: boolean; type: "control"; } | { cardId: number; costReduction: number; type: "playPermission"; } | { mustAttackUnitIfAble: boolean; type: "forcedAttack"; } | { type: "generic"; }

Defined in: packages/ts-sdk/src/generated/types/common.ts:167

Structured, localizable explanation of one active effect.

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

Union Members

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ hp: number; power: number; type: "stats"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ hp?: number | null; power?: number | null; type: "printedStats"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ keyword: string; type: "keyword"; value: number; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ keyword: string; type: "loseKeyword"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ granted: boolean; traitName: string; type: "trait"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ type: "abilityGrant"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ effect?: DelayedEffectDescriptionView | null; trigger: TriggerWindowView; type: "triggerGrant"; }

effect?

optional effect?: DelayedEffectDescriptionView | null

Summary of what resolves, when it is self-contained enough to name.

trigger

trigger: TriggerWindowView

Condensed trigger timing bucket.

type

type: "triggerGrant"

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ effect?: DelayedEffectDescriptionView | null; type: "bountyGrant"; }

effect?

optional effect?: DelayedEffectDescriptionView | null

Summary of the bounty reward, when self-contained enough to name.

type

type: "bountyGrant"

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ count: number; type: "whenPlayedReplay"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ type: "combatDamageEqualsRemainingHp"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ type: "entersReady"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ amount: number; scope: EffectCardScopeView; type: "costModifier"; uses?: number | null; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ scope: EffectCardScopeView; type: "aspectPenaltyIgnore"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ restriction: EffectRestrictionView; type: "restriction"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ amount?: number | null; effect: NamedCardEffectDescriptionView; name: string; type: "namedCard"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ amount?: number | null; combatOnly: boolean; type: "damagePrevention"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ type: "redirectDamage"; unitId: number; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ controller: Seat; owner: Seat; resource: boolean; type: "control"; }

controller

controller: Seat

Seat currently controlling the card.

owner

owner: Seat

Seat that regains the card when the control link ends.

resource

resource: boolean

True when the controlled card is a resource rather than a Unit.

type

type: "control"

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ cardId: number; costReduction: number; type: "playPermission"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ mustAttackUnitIfAble: boolean; type: "forcedAttack"; }

---

Type Literal

Example:

import type { ActiveEffectDescriptionView } from '@my-swu/simulator-client'

const activeEffectDescriptionView: ActiveEffectDescriptionView = {
  "type": "stats",
  "power": 0,
  "hp": 0,
}

console.log(activeEffectDescriptionView)

{ type: "generic"; }