Skip to content

ActionCtx

Defined in: core/define.ts:107

The engine handle available to actions and hooks (ADR 0001).

  • Omit<ReadCtx<O>, "turn" | "round" | "phase">

O

PN extends string

R = Json

readonly occupied: readonly number[]

Defined in: core/define.ts:66

Occupied or reserved seat numbers, ascending.

Omit.occupied


readonly options: O

Defined in: core/define.ts:67

Omit.options


readonly phase: object

Defined in: core/define.ts:114

readonly name: PN | null

go(name): void

PN

void


readonly random: Random

Defined in: core/define.ts:113


readonly round: CtxRound

Defined in: core/define.ts:118

Round controls. Only available in a phase (or game) with rounds.


readonly seats: readonly SeatInfo[]

Defined in: core/define.ts:64

Omit.seats


readonly status: TableStatus

Defined in: core/define.ts:60

Omit.status


readonly timers: CtxTimers

Defined in: core/define.ts:119


readonly turn: CtxTurn

Defined in: core/define.ts:116

Turn controls. Only available in a phase (or game) with turns.


readonly wallet: CtxWallet

Defined in: core/define.ts:121

Money: reserve and balance run now; commit, release and credit after commit (ADR 0007).

emit(name, payload?, options?): void

Defined in: core/define.ts:123

Sends an ephemeral event (not state) after this entry commits.

string

Json

EventAudience

void


end(...result): void

Defined in: core/define.ts:130

Ends the table with a result (typed and checked by the game's result schema, if any). onEnd runs at the end of this entry.

...Json extends R ? [result?: R] : [result: R]

void


now(): number

Defined in: core/define.ts:112

The entry's time, epoch ms. Constant for the whole entry (ADR 0006).

number


start(): void

Defined in: core/define.ts:125

Starts a table created with autoStart: false.

void