summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorduck <me@duck.me.uk>2020-06-27 16:21:17 +0000
committerGitHub <noreply@github.com>2020-06-27 18:21:17 +0200
commit1bc7047af724f9d6282f7cc79289ecdffe084d1c (patch)
tree9146423f086d8534dcb4219dc37f807891dd361b /src
parent75a2ae2f48a88a7496f135b020aeb5cf1c2924bb (diff)
downloadopenttd-1bc7047af724f9d6282f7cc79289ecdffe084d1c.tar.xz
Doc: Acknowledge integer type mismatch in certain admin packets using AdminUpdateType (#8238)
Diffstat (limited to 'src')
-rw-r--r--src/network/core/tcp_admin.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/network/core/tcp_admin.h b/src/network/core/tcp_admin.h
index 979e5963f..dc9753e89 100644
--- a/src/network/core/tcp_admin.h
+++ b/src/network/core/tcp_admin.h
@@ -134,7 +134,7 @@ protected:
/**
* Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet):
- * uint16 Update type (see #AdminUpdateType).
+ * uint16 Update type (see #AdminUpdateType). Note integer type - see "Certain Packet Information" in docs/admin_network.md.
* uint16 Update frequency (see #AdminUpdateFrequency), setting #ADMIN_FREQUENCY_POLL is always ignored.
* @param p The packet that was just received.
* @return The state the network should have.
@@ -143,7 +143,7 @@ protected:
/**
* Poll the server for certain updates, an invalid poll (e.g. not existent id) gets silently dropped:
- * uint8 #AdminUpdateType the server should answer for, only if #AdminUpdateFrequency #ADMIN_FREQUENCY_POLL is advertised in the PROTOCOL packet.
+ * uint8 #AdminUpdateType the server should answer for, only if #AdminUpdateFrequency #ADMIN_FREQUENCY_POLL is advertised in the PROTOCOL packet. Note integer type - see "Certain Packet Information" in docs/admin_network.md.
* uint32 ID relevant to the packet type, e.g.
* - the client ID for #ADMIN_UPDATE_CLIENT_INFO. Use UINT32_MAX to show all clients.
* - the company ID for #ADMIN_UPDATE_COMPANY_INFO. Use UINT32_MAX to show all companies.