mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-09-29 17:32:17 -07:00
Fix stale documentation and align doc comments with CONTRIBUTING guidelines
This commit is contained in:
parent
1ba839ca20
commit
d0df70e68f
14 changed files with 96 additions and 28 deletions
|
|
@ -268,7 +268,10 @@ Client
|
|||
**Server:**
|
||||
- `Server_Player::cmdIncCounter`
|
||||
- Rejects if the game has not started or the player has conceded
|
||||
- Updates the counter value
|
||||
- Rejects tax counters when command zone is disabled (`RespContextError`)
|
||||
- Rejects inactive tax counters (`RespContextError`)
|
||||
- Rejects if counter doesn't exist (`RespNameNotFound`)
|
||||
- Updates the counter value (clamped to `[minValue, maxValue]`)
|
||||
- Emits `Event_SetCounter` only if the value changed
|
||||
|
||||
**Client:**
|
||||
|
|
@ -285,7 +288,8 @@ Client
|
|||
**Server:**
|
||||
- `Server_Player::cmdCreateCounter`
|
||||
- Rejects if the game has not started or the player has conceded
|
||||
- Allocates a new counter ID
|
||||
- Rejects reserved tax counter names (`RespFunctionNotAllowed`)
|
||||
- Allocates a new counter ID (starting at `CounterIds::FirstUserId`)
|
||||
- Creates the counter
|
||||
- Emits `Event_CreateCounter`
|
||||
|
||||
|
|
@ -302,7 +306,10 @@ Client
|
|||
**Server:**
|
||||
- `Server_Player::cmdSetCounter`
|
||||
- Rejects if the game has not started or the player has conceded
|
||||
- Updates the counter value
|
||||
- Rejects tax counters when command zone is disabled (`RespContextError`)
|
||||
- Rejects inactive tax counters (`RespContextError`)
|
||||
- Rejects if counter doesn't exist (`RespNameNotFound`)
|
||||
- Updates the counter value (clamped to `[minValue, maxValue]`)
|
||||
- Emits `Event_SetCounter` only if the value changed
|
||||
|
||||
**Client:**
|
||||
|
|
@ -319,6 +326,8 @@ Client
|
|||
**Server:**
|
||||
- `Server_Player::cmdDelCounter`
|
||||
- Rejects if the game has not started or the player has conceded
|
||||
- Rejects tax counters (`RespFunctionNotAllowed`)
|
||||
- Rejects if counter doesn't exist (`RespNameNotFound`)
|
||||
- Deletes the counter
|
||||
- Emits `Event_DelCounter`
|
||||
|
||||
|
|
@ -521,6 +530,26 @@ Client
|
|||
|
||||
---
|
||||
|
||||
### `SET_COUNTER_ACTIVE` (1035)
|
||||
|
||||
**Purpose:** Show or hide a reserved tax counter without deleting it.
|
||||
|
||||
**Server:**
|
||||
- `Server_Player::cmdSetCounterActive`
|
||||
- Rejects if game not started (`RespGameNotStarted`)
|
||||
- Rejects if player has conceded (`RespContextError`)
|
||||
- Rejects for non-tax counters (`RespFunctionNotAllowed`)
|
||||
- Rejects if command zone is disabled (`RespContextError`)
|
||||
- Rejects if counter doesn't exist (`RespNameNotFound`)
|
||||
- Rejects deactivation when counter has non-zero value (`RespContextError`)
|
||||
- Emits `Event_SetCounterActive` only if the active state changed
|
||||
|
||||
**Client:**
|
||||
- `PlayerEventHandler::eventSetCounterActive`
|
||||
- Updates the counter's active state in the UI
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- Game commands are handled by `Server_Player`, `Server_AbstractParticipant`, or `Server_Game`, depending on the command.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue