From fb5399fc1813a91cf115e1b55fee5651080a1a89 Mon Sep 17 00:00:00 2001 From: Jona Walpert Date: Sun, 12 Apr 2026 01:06:41 +0200 Subject: [PATCH] Docs: add documentation for call command --- .../networking/commands/protocol-document.md | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/documents/docs/networking/commands/protocol-document.md b/documents/docs/networking/commands/protocol-document.md index f29b3dd..574b28f 100644 --- a/documents/docs/networking/commands/protocol-document.md +++ b/documents/docs/networking/commands/protocol-document.md @@ -63,6 +63,7 @@ This document describes the protocol for client-server communication in our appl - [Example Request](#example-request) - [Example Response](#example-response) - [RAISE command](#raise-command) + - [CALL command](#call-command) - [BET command](#bet-command) - [SEND_MESSAGE command](#send_message-command) - [Required pre-execution checks](#required-pre-execution-checks) @@ -779,6 +780,61 @@ END END ``` +## CALL command + +The `CALL` command lets the currently logged-in player match the current bet (call) in the ongoing game for their lobby. + +### Required pre-execution checks + +- [`UserLoggedInCheck`](#userloggedincheck) + +### Request Parameters + +| Parameter Name | Type | Optional | Description | +| :------------- | :--- | :------: | :---------- | +| `GAME_ID` | `int` | yes | Numeric id of the lobby/game to target. If omitted the server resolves the lobby by the requesting session's user. | + +### Implementation notes + +- Parser: `PlayerCallParser` — accepts optional `GAME_ID`. +- Handler: `PlayerCallHandler` — validates the session, resolves the lobby by id when provided or by session otherwise and forwards to `GameController`. + +### Success Response + +No additional response fields. Server replies with `+OK` on success. + +### Error Response + +| Code | Description | +| :--- | :---------- | +| `NOT_YOUR_TURN` | The player attempted to call when not their turn | +| `INSUFFICIENT_FUNDS` | Player does not have enough chips | +| `GAME_NOT_STARTED` | No game is running in the lobby | +| `NOT_IN_LOBBY` | Requesting user is not a member of the lobby | +| `LOBBY_NOT_FOUND` | The specified `GAME_ID` does not exist | + +### Example Request + +``` +CALL GAME_ID=1 +``` + +### Example Response (success) + +``` ++OK +END +``` + +### Example Response (error) + +``` +-ERR + CODE=NOT_YOUR_TURN + MSG=It is not your turn +END +``` + ## GET_LOBBY_STATUS command The `GET_LOBBY_STATUS` command requests the server to return the current state of a lobby, including the list of players and their ready state.