Literature Socket Channels

create

• Params

  • Player Name: name [string] [Required]
  • Player ID: pid [string] [Optional]

• Success Response:

  • Channel: game-updates [Private]
    Body: { code: 200, type: 'CREATE', gcode: [string], pid: [string], pname: [string] }

probe

• Params

  • Game Code: code [string] [Required]

• Success Response:

  • Channel: game-probe [Private]
    Body: { code: 200, data: [ { name: [string], position: [number] } ] }

join

• Params

  • Game Code: code [string] [Required]
  • Player Name: name [string] [Required]
  • Player Position: position [number] [Required]
  • Player ID: pid [string] [Optional]

• Success Response:

  • Channel: game-updates [Room]
    Body: { code: 200, type: 'JOIN', pname: [string], position: [number] }
  • Channel: game-updates [PRIVATE]
    Body: { code: 200, type: 'LIST', data: [ { name: [string], position: [number] } ] }

leave

• Params

  • Game Code: code [string] [Required]
  • Player ID: pid [string] [Required]

• Success Response:

  • Channel: game-updates [Room]
    Body: { code: 200, type: 'LEAVE', pname: [string], position: [number] }

start

• Params

  • Game Code: code [string] [Required]
  • Player ID: pid [string] [Required]

• Success Response:

  • Channel: game-updates [Room]
    Body: { code: 200, type: 'START' }

play-ask

• Params

  • Game Code: code [string] [Required]
  • Source Player ID: fid [string] [Required]
  • Destination Player Position: tpos [number] [Required]
  • Query Card: card [string] [Required]

• Success Response:

  • Channel: play-ask [Private]
    Body: { code: 200, type: 'ASK' }

play-transfer

• Params

  • Game Code: code [string] [Required]
  • Source Player ID: fid [string] [Required]
  • Destination Player Position: tpos [number] [Required]

• Success Response:

  • Channel: play-transfer [Private]
    Body: { code: 200, type: 'TRANSFER' }

play-declare

• Params

  • Game Code: code [string] [Required]
  • Player ID: fid [string] [Required]
  • Declaration: declaration [string[][]] [Required]

• Success Response:

  • Channel: play-declare [Private]
    Body: { code: 200, type: 'DECLARE' }

destroy

• Params
  • Game Code: code [string] [Required]
  • Player ID: pid [string] [Required]

game-data

• Success Response:
  • Channel: game-data [Room]
    Body: { type: 'GAME', data: [Game] }

player-data

• Success Response:
  • Channel: player-data [Private]
    Body: { type: 'PLAYER', data: [Player] }