Global

Members

(readonly) Message :string

Message IDs
Type:
  • string
Properties:
Name Type Description
CONNECT string
DISCONNECT string
CREATE_GUEST string
GET_MATCH_LIST string
PLAY_RANDOM string
CREATE_MATCH string
JOIN_MATCH string
ROLL_DICE string
MOVE_PIECE string
CONFIRM_MOVES string
UNDO_MOVES string
EVENT_PLAYER_JOINED string
EVENT_TURN_START string
EVENT_DICE_ROLL string
EVENT_PIECE_MOVE string
EVENT_MATCH_START string
EVENT_MATCH_OVER string
EVENT_GAME_OVER string
EVENT_GAME_RESTART string
EVENT_UNDO_MOVES string
Source:

(readonly) MoveActionType :string

Move action types are determined by rules. This is only a default list of actions that are shared by most rules.
Type:
  • string
Properties:
Name Type Description
MOVE string MOVE: Move piece from one point to another
RECOVER string RECOVER: Recover piece from bar and place it on board
HIT string HIT: Hit opponent's piece and sent it to bar
BEAR string BEAR: Bear piece - move it outside the board
Source:

(readonly) PieceType :number

Current version supports only two colours of checkers and two players as the author is not yet aware of rules with three or more types of checkers and/or players.
Type:
  • number
Properties:
Name Type Description
WHITE number White piece
BLACK number Black piece
Source:

Protocol :Object

Protocol options
Type:
  • Object
Source:

Type Definitions

messageCallback(msg, clientMsgSeq, reply)

Message callback
Parameters:
Name Type Description
msg number An integer.
clientMsgSeq number An integer.
reply Object Object containing reply data.
Properties
Name Type Description
result boolean Result of command execution
Source: