Game | fifth-aeon-bot-toolkit

Hierarchy

Game
- ServerGame
- ClientGame

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Game(name: string, format?: GameFormat): Game

- Defined in game.ts:87
Constructs a game given a format. The format informs how the game is initialized eg how much health each player starts with.

Parameters
- name: string
- Default value format: GameFormat = standardFormat
Returns Game

Properties

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

Protected orderableAttacks

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

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 Optional recivedChoice

recivedChoice: undefined | object

Protected turn

turn: number = 0

Protected turnNum

turnNum: number

Protected winner

winner: number = -1

Methods

addCardToPool

addCardToPool(card: Card): void

- Defined in game.ts:428
Parameters
- card: Card
Returns void

Protected addDeathHandlers

addDeathHandlers(): void

- Defined in game.ts:108
Returns void

addEnchantment

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

- Defined in game.ts:516
Parameters
- diesUponEntering: boolean
- enchantment: Enchantment
Returns void

addGameEvent

addGameEvent(event: GameSyncEvent): void

- Defined in game.ts:121
Parameters
- event: GameSyncEvent
Returns void

addToCrypt

addToCrypt(card: Card): void

- Defined in game.ts:199
Parameters
- card: Card
Returns void

addUnit

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

- Defined in game.ts:538
Parameters
- diesUponEntering: boolean
- unit: Unit
Returns void

Protected blockersExist

blockersExist(): boolean

- Defined in game.ts:410
Returns boolean

canTakeAction

canTakeAction(): boolean

- Defined in game.ts:244
Returns boolean

Protected changePhase

changePhase(nextPhase: GamePhase): void

- Defined in game.ts:438
Parameters
- nextPhase: GamePhase
Returns void

changeUnitOwner

changeUnitOwner(unit: Unit): void

- Defined in game.ts:484
Parameters
- unit: Unit
Returns void

deferChoice

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

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

Private enchantmentDeathEffects

enchantmentDeathEffects(enchantment: Enchantment): void

- Defined in game.ts:511
Parameters
- enchantment: Enchantment
Returns void

Protected endGame

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

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

Protected generateDamageDistribution

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

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

getActivePlayer

getActivePlayer(): number

- Defined in game.ts:585
Returns number

getAttackers

getAttackers(): Unit[]

- Defined in game.ts:263
Returns Unit[]

Private getBasicDamageDistribution

getBasicDamageDistribution(attacker: Unit, blockers: Unit[]): Unit[]

- Defined in game.ts:274
Parameters
- attacker: Unit
- blockers: Unit[]
Returns Unit[]

getBlockers

getBlockers(): Unit[]

- Defined in game.ts:268
Returns Unit[]

getBoard

getBoard(): Board

- Defined in game.ts:567
Returns Board

getCardById

getCardById(id: string): Card

- Defined in game.ts:605
Parameters
- id: string
Returns Card

getCrypt

getCrypt(player: number): Card[]

- Defined in game.ts:204
Parameters
- player: number
Returns Card[]

getCurrentPlayer

getCurrentPlayer(): Player

- Defined in game.ts:597
Returns Player

getCurrentPlayerUnits

getCurrentPlayerUnits(): Unit[]

- Defined in game.ts:575
Returns Unit[]

getEvents

getEvents(): GameEventSystem

- Defined in game.ts:571
Returns GameEventSystem

getLog

getLog(): undefined | Log

- Defined in game.ts:559
Returns undefined | Log

getModableDamageDistributions

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

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

getName

getName(): string

- Defined in game.ts:117
Returns string

getNonturnPlayer

getNonturnPlayer(): number

- Defined in game.ts:581
Returns number

getOtherPlayerNumber

getOtherPlayerNumber(playerNum: number): number

- 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)[]

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

getPhase

getPhase(): GamePhase

- Defined in game.ts:633
Returns GamePhase

getPlayer

getPlayer(playerNum: number): Player

- 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)[]

- 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

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

Protected getPlayerUnitById

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

- Defined in game.ts:623
Parameters
- playerNo: number
- id: string
Returns Unit

getUnitById

getUnitById(id: string): Unit

- Defined in game.ts:613
Parameters
- id: string
Returns Unit

getWinner

getWinner(): number

- 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

isActivePlayer

isActivePlayer(player: number): boolean

- Defined in game.ts:645
Parameters
- player: number
Returns boolean

isAttacking

isAttacking(): boolean

- Defined in game.ts:259
Returns boolean

isPlayPhase

isPlayPhase(): boolean

- Defined in game.ts:651
Returns boolean

isPlayerTurn

isPlayerTurn(player: number): boolean

- Defined in game.ts:641
Parameters
- player: number
Returns boolean

Protected makeDeferredChoice

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

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

mulligan

mulligan(): void

- Defined in game.ts:126
Returns void

nextTurn

nextTurn(): void

- Defined in game.ts:452
Returns void

playCard

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

- Defined in game.ts:216
Parameters
- player: Player
- card: Card
Returns void

playFromCrypt

playFromCrypt(card: Card): void

- Defined in game.ts:234
Parameters
- card: Card
Returns void

playGeneratedUnit

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

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

playPermanent

playPermanent(permanent: Permanent): void

- Defined in game.ts:472
Parameters
- permanent: Permanent
Returns void

playerCanAttack

playerCanAttack(playerNo: number): boolean

- Defined in game.ts:251
Parameters
- playerNo: number
Returns boolean

Abstract queryCards

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

- Defined in game.ts:210
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

- Defined in game.ts:145
Parameters
- action: QuitAction
Returns boolean

refresh

refresh(): void

- Defined in game.ts:463
Returns void

Protected removePermanent

removePermanent(perm: Permanent): void

- Defined in game.ts:505
Parameters
- perm: Permanent
Returns void

Protected resolveCombat

resolveCombat(): void

- Defined in game.ts:357
Returns void

returnPermanentToDeck

returnPermanentToDeck(perm: Permanent): void

- Defined in game.ts:495
Parameters
- perm: Permanent
Returns void

returnPermanentToHand

returnPermanentToHand(perm: Permanent): void

- Defined in game.ts:500
Parameters
- perm: Permanent
Returns void

Protected startEndPhase

startEndPhase(): void

- Defined in game.ts:446
Returns void

Private unitDeathEffects

unitDeathEffects(unit: Unit): void

- Defined in game.ts:531
Parameters
- unit: Unit
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

Default value format: GameFormat = standardFormat

Returns Game

Properties

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

Protected orderableAttacks

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 Optional recivedChoice

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

addToCrypt

Parameters

card: Card

Returns void

addUnit

Parameters

diesUponEntering: boolean

unit: Unit

Returns void

Protected blockersExist

Returns boolean

canTakeAction

Returns boolean

Protected changePhase

Parameters

nextPhase: GamePhase