Unit | fifth-aeon-bot-toolkit

Hierarchy

Permanent
- Unit
  - Player

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Unit(dataId: string, name: string, imageUrl: string, type: UnitType, cost: Resource, targeter: Targeter, damage: number, maxLife: number, mechanics: Array<Mechanic>): Unit

Overrides Card.constructor
- Defined in card-types/unit.ts:88
Parameters
- dataId: string
- name: string
- imageUrl: string
- type: UnitType
- cost: Resource
- targeter: Targeter
- damage: number
- maxLife: number
- mechanics: Array<Mechanic>
Returns Unit

Properties

Protected attackDisabled

attackDisabled: boolean

Protected attacking

attacking: boolean = false

Protected blockDisabled

blockDisabled: boolean

Protected blockedUnitId

blockedUnitId: string | null

Protected cost

cost: Resource

Protected damage

damage: number

Protected dataId

dataId: string

Protected died

died: boolean

Private dying

dying: boolean = false

Protected events

events: CardEventSystem = new CardEventSystem()

Protected exhausted

exhausted: boolean

Protected id

id: string

Protected imageUrl

imageUrl: string

Private immunities

immunities: Set<string>

Protected items

items: Item[]

Protected life

life: number

Protected location

location: GameZone

Protected maxLife

maxLife: number

Protected mechanics

mechanics: Mechanic[] = []

Protected name

name: string

Protected owner

owner: number = -1

Protected ready

ready: boolean

Protected targeter

targeter: Targeter

Protected Optional text

text: undefined | string

Protected unit

unit: boolean = false

Private unitType

unitType: UnitType

Static cardTypes

cardTypes: Set<CardType> = new Set([CardType.Unit, CardType.Item])

Methods

addImmunity

addImmunity(id: string): void

- Defined in card-types/unit.ts:172
Parameters
- id: string
Returns void

addItem

addItem(item: Item): void

- Defined in card-types/unit.ts:117
Parameters
- item: Item
Returns void

addMechanic

addMechanic(mechanic: Mechanic, game?: Game | null): void

- Defined in card-types/unit.ts:154
Parameters
- mechanic: Mechanic
- Default value game: Game | null = null
Returns void

Private afterDamage

afterDamage(target: Unit): void

- Defined in card-types/unit.ts:379
Parameters
- target: Unit
Returns void

annihilate

annihilate(): void

- Defined in card-types/unit.ts:430
Returns void

buff

buff(damage: number, maxLife: number): void

- Defined in card-types/unit.ts:292
Parameters
- damage: number
- maxLife: number
Returns void

canActivate

canActivate(): boolean

- Defined in card-types/unit.ts:318
Returns boolean

canAttack

canAttack(): boolean

- Defined in card-types/unit.ts:277
Returns boolean

canBlock

canBlock(): boolean

- Defined in card-types/unit.ts:216
Returns boolean

canBlockTarget

canBlockTarget(toBlock: Unit, hypothetical?: boolean): boolean

- Defined in card-types/unit.ts:220
Parameters
- toBlock: Unit
- Default value hypothetical: boolean = false
Returns boolean

checkDeath

checkDeath(): void

- Defined in card-types/unit.ts:361
Returns void

dealAndApplyDamage

dealAndApplyDamage(target: Unit, amount: number): void

- Defined in card-types/unit.ts:397
Parameters
- target: Unit
- amount: number
Returns void

Private dealDamageDelayed

dealDamageDelayed(target: Unit, amount: number): Damager

- Defined in card-types/unit.ts:375
Parameters
- target: Unit
- amount: number
Returns Damager

dealDamageInstant

dealDamageInstant(target: Unit, amount: number): void

Inherited from Card.dealDamageInstant
- Defined in card-types/card.ts:100
Parameters
- target: Unit
- amount: number
Returns void

detachItems

detachItems(game: Game): void

- Defined in card-types/unit.ts:423
Parameters
- game: Game
Returns void

die

die(): void

Overrides Permanent.die
- Defined in card-types/unit.ts:412
Returns void

draw

draw(): void

Inherited from Card.draw
- Defined in card-types/card.ts:96
Returns void

enterTheBattlefield

enterTheBattlefield(game: Game): void

Inherited from Card.enterTheBattlefield
- Defined in card-types/card.ts:159
Parameters
- game: Game
Returns void

evaluate

evaluate(game: Game, context: EvalContext, evaluated: EvalMap): number

Overrides Card.evaluate
- Defined in card-types/unit.ts:385
Parameters
- game: Game
- context: EvalContext
- evaluated: EvalMap
Returns number

evaluateTarget

evaluateTarget(target: Unit, game: Game, evaluated: EvalMap): number

Inherited from Card.evaluateTarget
- Defined in card-types/card.ts:228
Parameters
- target: Unit
- game: Game
- evaluated: EvalMap
Returns number

fight

fight(target: Unit, damage?: number | null): void

- Defined in card-types/unit.ts:326
Parameters
- target: Unit
- Default value damage: number | null = null
Returns void

getBlockedUnitId

getBlockedUnitId(): null | string

- Defined in card-types/unit.ts:281
Returns null | string

getCardType

getCardType(): CardType

Overrides Card.getCardType
- Defined in card-types/unit.ts:314
Returns CardType

getCost

getCost(): Resource

Inherited from Card.getCost
- Defined in card-types/card.ts:111
Returns Resource

getDamage

getDamage(): number

- Defined in card-types/unit.ts:200
Returns number

getDataId

getDataId(): string

Inherited from Card.getDataId
- Defined in card-types/card.ts:151
Returns string

getEvents

getEvents(): CardEventSystem

Inherited from Card.getEvents
- Defined in card-types/card.ts:70
Returns the cards event system. This is used to add or remove events

Returns CardEventSystem

getId

getId(): string

Inherited from Card.getId
- Defined in card-types/card.ts:155
Returns string

getImage

getImage(): string

Inherited from Card.getImage
- Defined in card-types/card.ts:115
Returns string

getLife

getLife(): number

- Defined in card-types/unit.ts:192
Returns number

getLocation

getLocation(): GameZone

Inherited from Card.getLocation
- Defined in card-types/card.ts:92
Returns GameZone

getMaxLife

getMaxLife(): number

- Defined in card-types/unit.ts:196
Returns number

getMultiplier

getMultiplier(game: Game, context: EvalContext, evaluated: EvalMap): number

- Defined in card-types/unit.ts:389
Parameters
- game: Game
- context: EvalContext
- evaluated: EvalMap
Returns number

getName

getName(): string

Inherited from Card.getName
- Defined in card-types/card.ts:208
Returns string

getOwner

getOwner(): number

Inherited from Card.getOwner
- Defined in card-types/card.ts:201
Returns number

getPrototype

getPrototype(): CardPrototype

Inherited from Card.getPrototype
- Defined in card-types/card.ts:135
Returns CardPrototype

getStats

getStats(): number

- Defined in card-types/unit.ts:204
Returns number

getTargeter

getTargeter(): Targeter

Inherited from Card.getTargeter
- Defined in card-types/card.ts:185
Returns Targeter

getTargeters

getTargeters(): Targeter[]

Inherited from Card.getTargeters
- Defined in card-types/card.ts:189
Returns Targeter[]

getText

getText(game?: Game): string

Inherited from Permanent.getText

Overrides Card.getText
- Defined in card-types/permanent.ts:10
Parameters
- Optional game: Game
Returns string

getUnitType

getUnitType(): UnitType

- Defined in card-types/unit.ts:188
Returns UnitType

hasMechanicWithId

hasMechanicWithId(id: string): undefined | Mechanic

- Defined in card-types/unit.ts:184
Parameters
- id: string
Returns undefined | Mechanic

isAttackDisabled

isAttackDisabled(): boolean

- Defined in card-types/unit.ts:265
Returns boolean

isAttacking

isAttacking(): boolean

Overrides Card.isAttacking
- Defined in card-types/unit.ts:241
Returns boolean

isBlockDisabled

isBlockDisabled(): boolean

- Defined in card-types/unit.ts:273
Returns boolean

isBlocking

isBlocking(): boolean

Overrides Card.isBlocking
- Defined in card-types/unit.ts:245
Returns boolean

isExhausted

isExhausted(): boolean

- Defined in card-types/unit.ts:249
Returns boolean

isImmune

isImmune(id: string): boolean

- Defined in card-types/unit.ts:180
Parameters
- id: string
Returns boolean

isPlayable

isPlayable(game: Game): boolean

Overrides Card.isPlayable
- Defined in card-types/unit.ts:125
Parameters
- game: Game
Returns boolean

isReady

isReady(): boolean

- Defined in card-types/unit.ts:237
Returns boolean

isUnit

isUnit(): boolean

Inherited from Card.isUnit
- Defined in card-types/card.ts:212
Returns boolean

kill

kill(instant: boolean): void

- Defined in card-types/unit.ts:367
Parameters
- instant: boolean
Returns void

leaveBoard

leaveBoard(game: Game): void

Overrides Permanent.leaveBoard
- Defined in card-types/unit.ts:401
Parameters
- game: Game
Returns void

play

play(game: Game): void

Overrides Card.play
- Defined in card-types/unit.ts:299
Parameters
- game: Game
Returns void

refresh

refresh(): void

- Defined in card-types/unit.ts:307
Returns void

removeImmunity

removeImmunity(id: string): void

- Defined in card-types/unit.ts:176
Parameters
- id: string
Returns void

removeItem

removeItem(item: Item): void

- Defined in card-types/unit.ts:121
Parameters
- item: Item
Returns void

removeMechanic

removeMechanic(id: string, game: Game): void

- Defined in card-types/unit.ts:145
Parameters
- id: string
- game: Game
Returns void

setAttackDisabled

setAttackDisabled(val: boolean): void

- Defined in card-types/unit.ts:261
Parameters
- val: boolean
Returns void

setBlockDisabled

setBlockDisabled(val: boolean): void

- Defined in card-types/unit.ts:269
Parameters
- val: boolean
Returns void

setBlocking

setBlocking(blockedId: string | null): void

- Defined in card-types/unit.ts:212
Parameters
- blockedId: string | null
Returns void

setExhausted

setExhausted(exhausted: boolean): void

- Defined in card-types/unit.ts:208
Parameters
- exhausted: boolean
Returns void

setId

setId(id: string): void

Inherited from Card.setId
- Defined in card-types/card.ts:197
Parameters
- id: string
Returns void

setLocation

setLocation(location: GameZone): void

Inherited from Card.setLocation
- Defined in card-types/card.ts:88
Parameters
- location: GameZone
Returns void

setOwner

setOwner(owner: number): void

Inherited from Card.setOwner
- Defined in card-types/card.ts:193
Parameters
- owner: number
Returns void

setStats

setStats(damage: number, maxLife: number): void

- Defined in card-types/unit.ts:285
Parameters
- damage: number
- maxLife: number
Returns void

setText

setText(text: string): void

Inherited from Card.setText
- Defined in card-types/card.ts:84
Parameters
- text: string
Returns void

takeDamage

takeDamage(amount: number, source: Card): number

- Defined in card-types/unit.ts:350
Parameters
- amount: number
- source: Card
Returns number

toString

toString(): string

Overrides Card.toString
- Defined in card-types/unit.ts:322
Returns string

toggleAttacking

toggleAttacking(): void

- Defined in card-types/unit.ts:253
Returns void

transform

transform(unit: Unit, game: Game): void

- Defined in card-types/unit.ts:129
Parameters
- unit: Unit
- game: Game
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dataId: string

name: string

imageUrl: string

type: UnitType

cost: Resource

targeter: Targeter

damage: number

maxLife: number

mechanics: Array<Mechanic>

Returns Unit

Properties

Protected attackDisabled

Protected attacking

Protected blockDisabled

Protected blockedUnitId

Protected cost

Protected damage

Protected dataId

Protected died

Private dying

Protected events

Protected exhausted

Protected id

Protected imageUrl

Private immunities

Protected items

Protected life

Protected location

Protected maxLife

Protected mechanics

Protected name

Protected owner

Protected ready

Protected targeter

Protected Optional text

Protected unit

Private unitType

Static cardTypes

Methods

addImmunity

Parameters

id: string

Returns void

addItem

Parameters

item: Item

Returns void

addMechanic

Parameters

mechanic: Mechanic

Default value game: Game | null = null

Returns void

Private afterDamage

Parameters

target: Unit

Returns void

annihilate

Returns void

buff

Parameters

damage: number

maxLife: number

Returns void

canActivate

Returns boolean

canAttack

Returns boolean

canBlock

Returns boolean

canBlockTarget

Parameters

toBlock: Unit