ActionCtx
Defined in: core/define.ts:107
The engine handle available to actions and hooks (ADR 0001).
Extends
Section titled “Extends”Omit<ReadCtx<O>,"turn"|"round"|"phase">
Type Parameters
Section titled “Type Parameters”O
PN extends string
R = Json
Properties
Section titled “Properties”occupied
Section titled “occupied”
readonlyoccupied: readonlynumber[]
Defined in: core/define.ts:66
Occupied or reserved seat numbers, ascending.
Inherited from
Section titled “Inherited from”Omit.occupied
options
Section titled “options”
readonlyoptions:O
Defined in: core/define.ts:67
Inherited from
Section titled “Inherited from”Omit.options
readonlyphase:object
Defined in: core/define.ts:114
readonlyname:PN|null
go(
name):void
Parameters
Section titled “Parameters”PN
Returns
Section titled “Returns”void
random
Section titled “random”
readonlyrandom:Random
Defined in: core/define.ts:113
readonlyround:CtxRound
Defined in: core/define.ts:118
Round controls. Only available in a phase (or game) with rounds.
readonlyseats: readonlySeatInfo[]
Defined in: core/define.ts:64
Inherited from
Section titled “Inherited from”Omit.seats
status
Section titled “status”
readonlystatus:TableStatus
Defined in: core/define.ts:60
Inherited from
Section titled “Inherited from”Omit.status
timers
Section titled “timers”
readonlytimers:CtxTimers
Defined in: core/define.ts:119
readonlyturn:CtxTurn
Defined in: core/define.ts:116
Turn controls. Only available in a phase (or game) with turns.
wallet
Section titled “wallet”
readonlywallet:CtxWallet
Defined in: core/define.ts:121
Money: reserve and balance run now; commit, release and credit after commit (ADR 0007).
Methods
Section titled “Methods”emit()
Section titled “emit()”emit(
name,payload?,options?):void
Defined in: core/define.ts:123
Sends an ephemeral event (not state) after this entry commits.
Parameters
Section titled “Parameters”string
payload?
Section titled “payload?”options?
Section titled “options?”Returns
Section titled “Returns”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.
Parameters
Section titled “Parameters”result
Section titled “result”...Json extends R ? [result?: R] : [result: R]
Returns
Section titled “Returns”void
now():
number
Defined in: core/define.ts:112
The entry's time, epoch ms. Constant for the whole entry (ADR 0006).
Returns
Section titled “Returns”number
start()
Section titled “start()”start():
void
Defined in: core/define.ts:125
Starts a table created with autoStart: false.
Returns
Section titled “Returns”void
