Docs: Adding Server Commands for Client Chat to the protocol document manually reverting changes

2026-04-10 23:25:05 +02:00
parent 97e5a55042
commit 9c09927d09
7 changed files with 109 additions and 36 deletions
@@ -341,4 +341,103 @@ LIST_USERS
    END
  END
 END
+```
+
+## SEND_MESSAGE command
+The `SEND_MESSAGE` command is used to transfer the chat message sent by a user to the server.
+### Required pre-execution checks
+None.
+
+### Request Parameters
+
+| Field    | Type            | Description                                                        |
+|:---------|:----------------|:-------------------------------------------------------------------|
+| `TYPE`   | `Enum<ChatType` | GLOBAL, LOBBY or WHISPER, specifying the Chat                      |
+| `GAME`   | `int`           | ID for identifying the Lobby Chat                                  |
+| `USER`   | `String`        | Username of the player that sent the message                       |
+| `TARGET` | `String`        | Username of to which the message is sent to (only in Whisper Chat) |
+| `TIME`   | `String`        | Timestamp, when the message was sent                               |
+| `TEXT`   | `String`        | Content of the message                                             |
+
+### Success Response
+No response fields.
+
+### Error Response
+None.
+
+### Example Request
+```
+SEND_MESSAGE TYPE=GLOBAL GAME=1 USER=player1 TARGET=null TIME='10:30' TEXT='Hello World'
+```
+
+### Example Response
+```
+OK
+END
+```
+
+## GET_MESSAGE_COUNT command
+The `GET_MESSAGE_COUNT` is used to get the current number of messages that are stored in the queue for a client.
+### Required pre-execution checks
+None.
+
+### Request Parameters
+No parameters.
+
+### Success Response
+
+| Field   | Type  | Description                    |
+|:--------|:------|:-------------------------------|
+| `COUNT` | `int` | The current number of messages |
+
+### Error Response
+| Code                 | Description                                                                      |
+| :------------------- |:---------------------------------------------------------------------------------|
+| `NO_USER_ASSOCIATED` | The session has no user associated, there is no queue of messages for the client |
+
+
+### Example Request
+```
+GET_MESSAGE_COUNT
+```
+
+### Example Response
+```
+OK
+COUNT=10
+END
+```
+
+## GET_NEXT_MESSAGE command
+The `GET_NEXT_MESSAGE` command is used to get the next message stored in a queue for the client.
+### Required pre-execution checks
+None.
+
+### Request Parameters
+No parameters.
+
+### Success Response
+| Field    | Type            | Description                                                        |
+|:---------|:----------------|:-------------------------------------------------------------------|
+| `TYPE`   | `Enum<ChatType` | GLOBAL, LOBBY or WHISPER, specifying the Chat                      |
+| `GAME`   | `int`           | ID for identifying the Lobby Chat                                  |
+| `USER`   | `String`        | Username of the player that sent the message                       |
+| `TARGET` | `String`        | Username of to which the message is sent to (only in Whisper Chat) |
+| `TIME`   | `String`        | Timestamp, when the message was sent                               |
+| `TEXT`   | `String`        | Content of the message                                             |
+### Error Response
+| Code                 | Description                                                                      |
+| :------------------- |:---------------------------------------------------------------------------------|
+| `NO_USER_ASSOCIATED` | The session has no user associated, there is no queue of messages for the client |
+
+### Example Request
+```
+GET_NEXT_MESSAGE
+```
+
+### Example Response
+```
+OK
+TYPE=GLOBAL GAME=-1 USER=player1 TARGET=null TIME=9:30 TEXT="Guten Tag"
+END
 ```