Skip to content
KCKingdoms Connected Scripting APIScripting guides and API
Data shapeServer APIGenerated

DiceProgressEvent

Defined in: server/api.d.ts:2954

An accepted server dice action. Notifications describe server decisions, which can precede the native animation. Seats and die-mask bits start at zero; turns and rolls start at one.

faces: number[]

Defined in: server/api.d.ts:2998

Six pip values (1 through 6) in die-index order on diceRoll; empty on other events. rolledMask identifies the dice rolled this time.


heldMask: number

Defined in: server/api.d.ts:3008

Bit mask of dice selected in the accepted move; zero otherwise.


match: number

Defined in: server/api.d.ts:2958

Match ID.


moveIndex: number

Defined in: server/api.d.ts:2983

Number of accepted moves so far.


player: number

Defined in: server/api.d.ts:2963

Network ID of the acting player.


points: number

Defined in: server/api.d.ts:3013

Points added by diceMove or banked by a passed diceTurnEnd; zero otherwise.


reason: string

Defined in: server/api.d.ts:3018

continue or pass on diceMove; bust or rolled on diceRoll; pass, bust, won, gaveUp, left, timedOut, failed, or stopped on diceTurnEnd; empty on diceTurnStart.


roll: number

Defined in: server/api.d.ts:2978

Roll within the turn; 0 before its first roll.


rolledMask: number

Defined in: server/api.d.ts:3003

Bit mask of dice rolled, on diceRoll; zero otherwise.


seat: number

Defined in: server/api.d.ts:2968

Acting seat: 0 for first, 1 for second.


totalScore: number

Defined in: server/api.d.ts:2993

This seat’s banked score.


turn: number

Defined in: server/api.d.ts:2973

Turn number across both seats, starting at 1.


turnScore: number

Defined in: server/api.d.ts:2988

Unbanked points in this turn, before they are lost on a bust or banked on a pass.