From 730687080ab2aa0bf62e9282bd9ac90c75da5f5d Mon Sep 17 00:00:00 2001 From: rubidium42 Date: Sat, 15 Apr 2023 11:10:09 +0200 Subject: [PATCH] Fix: Update some network documentation to match the new command system (#10657) --- src/network/core/tcp_admin.h | 6 ++---- src/network/core/tcp_game.h | 12 ++++-------- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/src/network/core/tcp_admin.h b/src/network/core/tcp_admin.h index 97af6f0f41..971ea46d0f 100644 --- a/src/network/core/tcp_admin.h +++ b/src/network/core/tcp_admin.h @@ -464,10 +464,8 @@ protected: * uint32 ID of the client sending the command. * uint8 ID of the company (0..MAX_COMPANIES-1). * uint16 ID of the command. - * uint32 P1 (variable data passed to the command). - * uint32 P2 (variable data passed to the command). - * uint32 Tile where this is taking place. - * string Text passed to the command. + * Command specific buffer with encoded parameters of variable length. + * The content differs per command and can change without notification. * uint32 Frame of execution. * @param p The packet that was just received. * @return The state the network should have. diff --git a/src/network/core/tcp_game.h b/src/network/core/tcp_game.h index 591a91ac1b..cd0facd781 100644 --- a/src/network/core/tcp_game.h +++ b/src/network/core/tcp_game.h @@ -335,10 +335,8 @@ protected: * Send a DoCommand to the Server: * uint8 ID of the company (0..MAX_COMPANIES-1). * uint32 ID of the command (see command.h). - * uint32 P1 (free variables used in DoCommand). - * uint32 P2 - * uint32 Tile where this is taking place. - * string Text. + * Command specific buffer with encoded parameters of variable length. + * The content differs per command and can change without notification. * uint8 ID of the callback. * @param p The packet that was just received. */ @@ -348,10 +346,8 @@ protected: * Sends a DoCommand to the client: * uint8 ID of the company (0..MAX_COMPANIES-1). * uint32 ID of the command (see command.h). - * uint32 P1 (free variable used in DoCommand). - * uint32 P2. - * uint32 Tile where this is taking place. - * string Text. + * Command specific buffer with encoded parameters of variable length. + * The content differs per command and can change without notification. * uint8 ID of the callback. * uint32 Frame of execution. * @param p The packet that was just received.