ClientGame | fifth-aeon-bot-toolkit

Hierarchy

Game
- ClientGame

Index

Constructors

constructor

Methods

Constructors

constructor

new ClientGame(name: string, runGameAction: GameActionRunner, animator: Animator, log?: Log, format?: GameFormat): ClientGame

Overrides Game.constructor
- Defined in clientGame.ts:41
Parameters
- name: string
- runGameAction: GameActionRunner
- animator: Animator
- Optional log: Log
- Default value format: GameFormat = standardFormat
Returns ClientGame

Properties

Private animator

animator: Animator

Protected attackDamageOrder

attackDamageOrder: Map<string, Unit[]> | null = null

Protected attackers

attackers: Unit[]

Protected blockers

blockers: [Unit, Unit][]

Protected board

board: Board

Protected cardPool

cardPool: Map<string, Card>

Protected client

client: boolean = false

Protected crypt

crypt: [Card[], Card[]]

Protected currentChoices

currentChoices: (null | Choice)[] = [null, null]

Protected generatedCardId

generatedCardId: number = 1

id

id: string = ""

lastCardsPlayed

lastCardsPlayed: string[] = []

Protected lastPhase

lastPhase: GamePhase = GamePhase.Play1

Protected lastPlayedCardName

lastPlayedCardName: string = "None"

Protected log

log: Log | undefined

Protected name

name: string

Private nextExpectedEvent

nextExpectedEvent: number = 0

Protected orderableAttacks

orderableAttacks: Map<string, Unit[]> | null = null

Private owningPlayer

owningPlayer: number = 0

Protected phase

phase: GamePhase = GamePhase.Play1

Protected players

players: Player[] = []

promptCardChoice

promptCardChoice: function

Type declaration

- (player: number, choices: Card[], min: number, max: number, callback: function | null, message: string, evaluator: ChoiceHeuristic): void
- Parameters
  - player: number
  - choices: Card[]
  - min: number
  - max: number
  - callback: function | null
  - message: string
  - evaluator: ChoiceHeuristic
  Returns void

Protected queryData

queryData: Card[] | null = null

Protected Optional recivedChoice

recivedChoice: undefined | object

Protected runGameAction

runGameAction: GameActionRunner

Private shouldAnimate

shouldAnimate: boolean = false

Private syncSystem

syncSystem: SyncEventSystem = new SyncEventSystem(this)

Protected turn

turn: number = 0

Protected turnNum

turnNum: number

Protected winner

winner: number = -1

Methods

addCardToPool

addCardToPool(card: Card): void

Inherited from Game.addCardToPool
- Defined in game.ts:428
Parameters
- card: Card
Returns void

Protected addDeathHandlers

addDeathHandlers(): void

Inherited from Game.addDeathHandlers
- Defined in game.ts:108
Returns void

addEnchantment

addEnchantment(diesUponEntering: boolean, enchantment: Enchantment): void

Inherited from Game.addEnchantment
- Defined in game.ts:516
Parameters
- diesUponEntering: boolean
- enchantment: Enchantment
Returns void

addGameEvent

addGameEvent(event: GameSyncEvent): void

Inherited from Game.addGameEvent
- Defined in game.ts:121
Parameters
- event: GameSyncEvent
Returns void

Private addSyncHandlers

addSyncHandlers(): void

- Defined in clientGame.ts:491
Returns void

addToCrypt

addToCrypt(card: Card): void

Inherited from Game.addToCrypt
- Defined in game.ts:199
Parameters
- card: Card
Returns void

addUnit

addUnit(diesUponEntering: boolean, unit: Unit): void

Inherited from Game.addUnit
- Defined in game.ts:538
Parameters
- diesUponEntering: boolean
- unit: Unit
Returns void

Protected blockersExist

blockersExist(): boolean

Inherited from Game.blockersExist
- Defined in game.ts:410
Returns boolean

canAttackWith

canAttackWith(unit: Unit): boolean

- Defined in clientGame.ts:204
Parameters
- unit: Unit
Returns boolean

canMakeChoice

canMakeChoice(player: number, cards: Card[]): boolean

- Defined in clientGame.ts:240
Parameters
- player: number
- cards: Card[]
Returns boolean

canModifyEnchantment

canModifyEnchantment(enchantment: Enchantment): boolean

- Defined in clientGame.ts:180
Parameters
- enchantment: Enchantment
Returns boolean

canPlayCard

canPlayCard(card: Card, targets?: Unit[], host?: Unit | null): boolean

- Defined in clientGame.ts:90
Checks if the player controlling this game can play a given card with given targets

Parameters
- card: Card
- Default value targets: Unit[] = []
- Default value host: Unit | null = null
Returns boolean

canPlayResource

canPlayResource(): boolean

- Defined in clientGame.ts:281
Returns boolean

canTakeAction

canTakeAction(): boolean

Inherited from Game.canTakeAction
- Defined in game.ts:244
Returns boolean

Protected changePhase

changePhase(nextPhase: GamePhase): void

Inherited from Game.changePhase
- Defined in game.ts:438
Parameters
- nextPhase: GamePhase
Returns void

changeUnitOwner

changeUnitOwner(unit: Unit): void

Inherited from Game.changeUnitOwner
- Defined in game.ts:484
Parameters
- unit: Unit
Returns void

declareAttacker

declareAttacker(unit: Unit): boolean

- Defined in clientGame.ts:212
Parameters
- unit: Unit
Returns boolean

declareBlocker

declareBlocker(blocker: Unit, attacker: Unit | null): boolean

- Defined in clientGame.ts:225
Parameters
- blocker: Unit
- attacker: Unit | null
Returns boolean

deferChoice

deferChoice(player: number, choices: Card[], min: number, max: number, callback: function | null): void

Inherited from Game.deferChoice
- Defined in game.ts:161
Parameters
- player: number
- choices: Card[]
- min: number
- max: number
- callback: function | null
Returns void

enableAnimations

enableAnimations(): void

- Defined in clientGame.ts:341
Returns void

Protected endGame

endGame(winningPlayer: number, quit?: boolean): void

Inherited from Game.endGame
- Defined in game.ts:133
Parameters
- winningPlayer: number
- Default value quit: boolean = false
Returns void

Protected generateDamageDistribution

generateDamageDistribution(): Map<string, Unit[]>

Inherited from Game.generateDamageDistribution
- Defined in game.ts:296
Returns Map<string, Unit[]>

getActivePlayer

getActivePlayer(): number

Inherited from Game.getActivePlayer
- Defined in game.ts:585
Returns number

getAttackers

getAttackers(): Unit[]

Inherited from Game.getAttackers
- Defined in game.ts:263
Returns Unit[]

getBlockers

getBlockers(): Unit[]

Inherited from Game.getBlockers
- Defined in game.ts:268
Returns Unit[]

getBoard

getBoard(): Board

Inherited from Game.getBoard
- Defined in game.ts:567
Returns Board

getCardById

getCardById(id: string): Card

Inherited from Game.getCardById
- Defined in game.ts:605
Parameters
- id: string
Returns Card

getCrypt

getCrypt(player: number): Card[]

Inherited from Game.getCrypt
- Defined in game.ts:204
Parameters
- player: number
Returns Card[]

getCurrentPlayer

getCurrentPlayer(): Player

Inherited from Game.getCurrentPlayer
- Defined in game.ts:597
Returns Player

getCurrentPlayerUnits

getCurrentPlayerUnits(): Unit[]

Inherited from Game.getCurrentPlayerUnits
- Defined in game.ts:575
Returns Unit[]

getEvents

getEvents(): GameEventSystem

Inherited from Game.getEvents
- Defined in game.ts:571
Returns GameEventSystem

getExpectedCards

getExpectedCards(): number

- Defined in clientGame.ts:582
Returns number

getLog

getLog(): undefined | Log

Overrides Game.getLog
- Defined in clientGame.ts:83
Returns undefined | Log

getModableDamageDistributions

getModableDamageDistributions(): Map<string, Unit[]>

Inherited from Game.getModableDamageDistributions
- Defined in game.ts:333
Returns Map<string, Unit[]>

getName

getName(): string

Inherited from Game.getName
- Defined in game.ts:117
Returns string

getNonturnPlayer

getNonturnPlayer(): number

Inherited from Game.getNonturnPlayer
- Defined in game.ts:581
Returns number

getOtherPlayerNumber

getOtherPlayerNumber(playerNum: number): number

Inherited from Game.getOtherPlayerNumber
- Defined in game.ts:593
Parameters
- playerNum: number
Returns number

getPastEvents

getPastEvents(): (SyncAttackToggled | SyncTurnStart | SyncPriorityGained | SyncPhaseChange | SyncPlayResource | SyncPlayCard | SyncBlock | SyncDraw | SyncFatigue | SyncChoiceMade | SyncQueryResult | SyncEnded | SyncEnchantmentModified | SyncDamageDistributed)[]

Inherited from Game.getPastEvents
- Defined in game.ts:432
Returns (SyncAttackToggled | SyncTurnStart | SyncPriorityGained | SyncPhaseChange | SyncPlayResource | SyncPlayCard | SyncBlock | SyncDraw | SyncFatigue | SyncChoiceMade | SyncQueryResult | SyncEnded | SyncEnchantmentModified | SyncDamageDistributed)[]

getPhase

getPhase(): GamePhase

Inherited from Game.getPhase
- Defined in game.ts:633
Returns GamePhase

getPlayer

getPlayer(playerNum: number): Player

Inherited from Game.getPlayer
- Defined in game.ts:563
Parameters
- playerNum: number
Returns Player

getPlayerActions

getPlayerActions(): (SyncAttackToggled | SyncTurnStart | SyncPriorityGained | SyncPhaseChange | SyncPlayResource | SyncPlayCard | SyncBlock | SyncDraw | SyncFatigue | SyncChoiceMade | SyncQueryResult | SyncEnded | SyncEnchantmentModified | SyncDamageDistributed)[]

Inherited from Game.getPlayerActions
- Defined in game.ts:637
Returns (SyncAttackToggled | SyncTurnStart | SyncPriorityGained | SyncPhaseChange | SyncPlayResource | SyncPlayCard | SyncBlock | SyncDraw | SyncFatigue | SyncChoiceMade | SyncQueryResult | SyncEnded | SyncEnchantmentModified | SyncDamageDistributed)[]

Protected getPlayerCardById

getPlayerCardById(player: Player, id: string): Card | undefined

Inherited from Game.getPlayerCardById
- Defined in game.ts:601
Parameters
- player: Player
- id: string
Returns Card | undefined

Protected getPlayerUnitById

getPlayerUnitById(playerNo: number, id: string): Unit

Inherited from Game.getPlayerUnitById
- Defined in game.ts:623
Parameters
- playerNo: number
- id: string
Returns Unit

getUnitById

getUnitById(id: string): Unit

Inherited from Game.getUnitById
- Defined in game.ts:613
Parameters
- id: string
Returns Unit

getWinner

getWinner(): number

Inherited from Game.getWinner
- Defined in game.ts:156
Returns the number of the player who has won the game. If it is still in progress it will return -1;

Returns number

Private idsToCards

idsToCards(ids: Array<string>): Card[]

- Defined in clientGame.ts:475
Parameters
- ids: Array<string>
Returns Card[]

isActivePlayer

isActivePlayer(player: number): boolean

Inherited from Game.isActivePlayer
- Defined in game.ts:645
Parameters
- player: number
Returns boolean

isAttacking

isAttacking(): boolean

Inherited from Game.isAttacking
- Defined in game.ts:259
Returns boolean

isPlayPhase

isPlayPhase(): boolean

Inherited from Game.isPlayPhase
- Defined in game.ts:651
Returns boolean

isPlayerTurn

isPlayerTurn(player: number): boolean

Inherited from Game.isPlayerTurn
- Defined in game.ts:641
Parameters
- player: number
Returns boolean

isSyncronized

isSyncronized(): boolean

- Defined in clientGame.ts:441
Returns boolean

makeChoice

makeChoice(player: number, cards: Card[]): boolean

- Defined in clientGame.ts:268
Parameters
- player: number
- cards: Card[]
Returns boolean

Protected makeDeferredChoice

makeDeferredChoice(player: number, cards: Card[]): void

Inherited from Game.makeDeferredChoice
- Defined in game.ts:185
Parameters
- player: number
- cards: Card[]
Returns void

modifyEnchantment

modifyEnchantment(player: Player, enchantment: Enchantment): boolean

- Defined in clientGame.ts:187
Parameters
- player: Player
- enchantment: Enchantment
Returns boolean

mulligan

mulligan(): void

Inherited from Game.mulligan
- Defined in game.ts:126
Returns void

nextTurn

nextTurn(): void

Inherited from Game.nextTurn
- Defined in game.ts:452
Returns void

Protected onQueryResult

onQueryResult(): null

- Defined in clientGame.ts:40
Returns null

onSync

onSync(): null

- Defined in clientGame.ts:41
Returns null

pass

pass(): boolean

- Defined in clientGame.ts:310
Returns boolean

playCard

playCard(player: Player, card: Card): void

Inherited from Game.playCard
- Defined in game.ts:216
Parameters
- player: Player
- card: Card
Returns void

playCardExtern

playCardExtern(card: Card, targets?: Unit[], host?: Unit | null): boolean

- Defined in clientGame.ts:130
Invoked by the player or A.I to play a card.

It will return false if it is not currently legal to play the card. Otherwise it will play the card then send the action to the server.

Parameters
- card: Card
  
  The card to play
- Default value targets: Unit[] = []
  
  The card's targets (empty array if it has none)
- Default value host: Unit | null = null
  
  The card's host if it is an item or null if it is not an item
Returns boolean

playFromCrypt

playFromCrypt(card: Card): void

Inherited from Game.playFromCrypt
- Defined in game.ts:234
Parameters
- card: Card
Returns void

playGeneratedUnit

playGeneratedUnit(player: Player | number, card: Card): Unit

Inherited from Game.playGeneratedUnit
- Defined in game.ts:222
Parameters
- player: Player | number
- card: Card
Returns Unit

playPermanent

playPermanent(permanent: Permanent): void

Inherited from Game.playPermanent
- Defined in game.ts:472
Parameters
- permanent: Permanent
Returns void

playResource

playResource(type: string): boolean

- Defined in clientGame.ts:288
Parameters
- type: string
Returns boolean

playerCanAttack

playerCanAttack(playerNo: number): boolean

Inherited from Game.playerCanAttack
- Defined in game.ts:251
Parameters
- playerNo: number
Returns boolean

queryCards

queryCards(getCards: function, callback: function): void

Overrides Game.queryCards
- Defined in clientGame.ts:328
Parameters
- getCards: function
  - - (game: ServerGame): Card[]
    - Parameters
      - game: ServerGame
      Returns Card[]
- callback: function
  - - (cards: Card[]): void
    - Parameters
      - cards: Card[]
      Returns void
Returns void

Protected quit

quit(action: QuitAction): boolean

Inherited from Game.quit
- Defined in game.ts:145
Parameters
- action: QuitAction
Returns boolean

refresh

refresh(): void

Inherited from Game.refresh
- Defined in game.ts:463
Returns void

Protected removePermanent

removePermanent(perm: Permanent): void

Inherited from Game.removePermanent
- Defined in game.ts:505
Parameters
- perm: Permanent
Returns void

Protected resolveCombat

resolveCombat(): Promise<void>

Overrides Game.resolveCombat
- Defined in clientGame.ts:345
Returns Promise<void>

returnPermanentToDeck

returnPermanentToDeck(perm: Permanent): void

Inherited from Game.returnPermanentToDeck
- Defined in game.ts:495
Parameters
- perm: Permanent
Returns void

returnPermanentToHand

returnPermanentToHand(perm: Permanent): void

Inherited from Game.returnPermanentToHand
- Defined in game.ts:500
Parameters
- perm: Permanent
Returns void

setAttackOrder

setAttackOrder(attacker: Unit, order: Unit[]): boolean

- Defined in clientGame.ts:166
When an attacking unit is blocked by multiple defenders, the attacker's owner may set the order damage is delt in. This function does that for a given attacker and an ordered list of blockers.

Parameters
- attacker: Unit
  
  The unit that has been blocked
- order: Unit[]
  
  The blockers in the order that damage should be applied to them
Returns boolean

setOwningPlayer

setOwningPlayer(player: number): void

- Defined in clientGame.ts:324
Parameters
- player: number
Returns void

Private setQueryResult

setQueryResult(cards: Card[]): void

- Defined in clientGame.ts:670
Parameters
- cards: Card[]
Returns void

Protected startEndPhase

startEndPhase(): void

Inherited from Game.startEndPhase
- Defined in game.ts:446
Returns void

Private syncAttackToggled

syncAttackToggled(localPlayerNumber: number, event: SyncAttackToggled): void

- Defined in clientGame.ts:626
Parameters
- localPlayerNumber: number
- event: SyncAttackToggled
Returns void

Private syncBlock

syncBlock(localPlayerNumber: number, event: SyncBlock): void

- Defined in clientGame.ts:635
Parameters
- localPlayerNumber: number
- event: SyncBlock
Returns void

Private syncCardEvent

syncCardEvent(localPlayerNumber: number, event: SyncPlayCard): void

- Defined in clientGame.ts:545
Parameters
- localPlayerNumber: number
- event: SyncPlayCard
Returns void

Private syncChoiceMade

syncChoiceMade(localPlayerNumber: number, event: SyncChoiceMade): void

- Defined in clientGame.ts:661
Parameters
- localPlayerNumber: number
- event: SyncChoiceMade
Returns void

Private syncDamageDistribution

syncDamageDistribution(localPlayerNumber: number, event: SyncDamageDistributed): void

- Defined in clientGame.ts:527
Parameters
- localPlayerNumber: number
- event: SyncDamageDistributed
Returns void

Private syncDrawEvent

syncDrawEvent(localPlayerNumber: number, event: SyncDraw | SyncFatigue): void

- Defined in clientGame.ts:589
Parameters
- localPlayerNumber: number
- event: SyncDraw | SyncFatigue
Returns void

Private syncEnded

syncEnded(localPlayerNumber: number, event: SyncEnded): void

- Defined in clientGame.ts:683
Parameters
- localPlayerNumber: number
- event: SyncEnded
Returns void

Private syncModifyEnchantment

syncModifyEnchantment(localPlayerNumber: number, event: SyncEnchantmentModified): void

- Defined in clientGame.ts:569
Parameters
- localPlayerNumber: number
- event: SyncEnchantmentModified
Returns void

Private syncPhaseChange

syncPhaseChange(localPlayerNumber: number, event: SyncPhaseChange): void

- Defined in clientGame.ts:641
Parameters
- localPlayerNumber: number
- event: SyncPhaseChange
Returns void

Private syncPlayResource

syncPlayResource(localPlayerNumber: number, event: SyncPlayResource): void

- Defined in clientGame.ts:617
Parameters
- localPlayerNumber: number
- event: SyncPlayResource
Returns void

Private syncQueryResult

syncQueryResult(localPlayerNumber: number, event: SyncQueryResult): void

- Defined in clientGame.ts:678
Parameters
- localPlayerNumber: number
- event: SyncQueryResult
Returns void

syncServerEvent

syncServerEvent(localPlayerNumber: number, event: GameSyncEvent): void

- Defined in clientGame.ts:448
Syncs an event that happened on the server into the state of this game model

Parameters
- localPlayerNumber: number
- event: GameSyncEvent
Returns void

Private syncTurnStart

syncTurnStart(localPlayerNumber: number, event: SyncTurnStart): void

- Defined in clientGame.ts:608
Parameters
- localPlayerNumber: number
- event: SyncTurnStart
Returns void

unpackCard

unpackCard(proto: CardPrototype): Card

- Defined in clientGame.ts:479
Parameters
- proto: CardPrototype
Returns Card

Private wouldEndTurn

wouldEndTurn(): boolean

- Defined in clientGame.ts:302
Returns boolean

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

runGameAction: GameActionRunner

animator: Animator

Optional log: Log

Default value format: GameFormat = standardFormat

Returns ClientGame

Properties

Private animator

Protected attackDamageOrder

Protected attackers

Protected blockers

Protected board

Protected cardPool

Protected client

Protected crypt

Protected currentChoices

Protected events

Protected format

gameEvents

Protected generatedCardId

id

lastCardsPlayed

Protected lastPhase

Protected lastPlayedCardName

Protected log

Protected name

Private nextExpectedEvent

Protected orderableAttacks

Private owningPlayer

Protected phase

Protected players

promptCardChoice

Type declaration

Parameters

player: number

choices: Card[]

min: number

max: number

callback: function | null

message: string

evaluator: ChoiceHeuristic

Returns void

Protected queryData

Protected Optional recivedChoice

Protected runGameAction

Private shouldAnimate

Private syncSystem

Protected turn

Protected turnNum

Protected winner

Methods

addCardToPool

Parameters

card: Card

Returns void

Protected addDeathHandlers

Returns void

addEnchantment

Parameters

diesUponEntering: boolean

enchantment: Enchantment

Returns void

addGameEvent

Parameters

event: GameSyncEvent

Returns void

Private addSyncHandlers

Returns void

addToCrypt

Parameters

card: Card

Returns void