mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Fix: Update some network documentation to match the new command system (#10657)

pull/10647/head
rubidium42 2023-04-15 11:10:09 +02:00 committed by GitHub
parent 646a7e625b
commit 730687080a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/network/core/tcp_admin.h
View File

@ -464,10 +464,8 @@ protected:
* uint32 ID of the client sending the command. * uint32 ID of the client sending the command.
* uint8 ID of the company (0..MAX_COMPANIES-1). * uint8 ID of the company (0..MAX_COMPANIES-1).
* uint16 ID of the command. * uint16 ID of the command.
* uint32 P1 (variable data passed to the command). * <var> Command specific buffer with encoded parameters of variable length.
* uint32 P2 (variable data passed to the command). * The content differs per command and can change without notification.
* uint32 Tile where this is taking place.
* string Text passed to the command.
* uint32 Frame of execution. * uint32 Frame of execution.
* @param p The packet that was just received. * @param p The packet that was just received.
* @return The state the network should have. * @return The state the network should have.

12
src/network/core/tcp_game.h
View File

@ -335,10 +335,8 @@ protected:
* Send a DoCommand to the Server: * Send a DoCommand to the Server:
* uint8 ID of the company (0..MAX_COMPANIES-1). * uint8 ID of the company (0..MAX_COMPANIES-1).
* uint32 ID of the command (see command.h). * uint32 ID of the command (see command.h).
* uint32 P1 (free variables used in DoCommand). * <var> Command specific buffer with encoded parameters of variable length.
* uint32 P2 * The content differs per command and can change without notification.
* uint32 Tile where this is taking place.
* string Text.
* uint8 ID of the callback. * uint8 ID of the callback.
* @param p The packet that was just received. * @param p The packet that was just received.
*/ */
@ -348,10 +346,8 @@ protected:
* Sends a DoCommand to the client: * Sends a DoCommand to the client:
* uint8 ID of the company (0..MAX_COMPANIES-1). * uint8 ID of the company (0..MAX_COMPANIES-1).
* uint32 ID of the command (see command.h). * uint32 ID of the command (see command.h).
* uint32 P1 (free variable used in DoCommand). * <var> Command specific buffer with encoded parameters of variable length.
* uint32 P2. * The content differs per command and can change without notification.
* uint32 Tile where this is taking place.
* string Text.
* uint8 ID of the callback. * uint8 ID of the callback.
* uint32 Frame of execution. * uint32 Frame of execution.
* @param p The packet that was just received. * @param p The packet that was just received.