Server message format

From ioquake3 wiki

You do not have permission to edit this page, for the following reason:

You can view and copy the source of this page:

At its basic level, a server message consists of the ID of the last client command that it received along with a list of server operations. There are several different types of server operations. To identify which type of operation it is, each operation in the list starts with an 8-bit identifier code. The last operation in the list is identified with a special EOF code. == Structures == === top-level format === {{FormatTable|1= {{FmtBits|32|bits|ID of last client command received}} {{FmtSubF|(<[[#nop|nop]]> &#124; <[[#gamestate|gamestate]]> &#124; <[[#server-command|server-command]]> &#124; <[[#download|download]]> &#124; <[[#snapshot|snapshot]]>)*}} {{FmtBits|8 |bits|'''0x08''' EOF indicator}} }} === nop === {{FormatTable|1= {{FmtBits|8 |bits|'''0x01''' nop indicator}} }} === gamestate === {{FormatTable|1= {{FmtBits|8 |bits|'''0x02''' gamestate indicator}} {{FmtBits|32|bits|server's last command ID}} {{FmtSubF|(<[[#configstring|configstring]]> &#124; <[[#baseline|baseline]]>)*}} {{FmtBits|8 |bits|'''0x08''' EOF indicator}} {{FmtBits|32|bits|client ID}} {{FmtBits|32|bits|randomly generated checksum seed value}} }} === configstring === {{FormatTable|1= {{FmtBits|8 |bits|'''0x03''' configstring indicator}} {{FmtBits|16|bits|config ID}} {{FmtOthr|string |config value}} }} === baseline === {{FormatTable|1= {{FmtBits|8 |bits|'''0x04''' baseline indicator}} {{FmtSubF|<[[#entity|entity]]>}} }} === server-command === {{FormatTable|1= {{FmtBits|8 |bits|'''0x05''' server-command indicator}} {{FmtBits|32|bits|command ID}} {{FmtOthr|string |command value}} }} === download === {{FormatTable|1= {{FmtBits|8 |bits|'''0x06''' download indicator}} {{FmtBits|16|bits|block number}} {{FmtExpr|if {block number} &#61;&#61; 0x0000: // first block}} {{FmtSubT|1= {{FmtBits|32|bits|file size}} {{FmtExpr|if {file size} &#61;&#61; 0xFFFFFFFF: // error indicator}} {{FmtSubT|1= {{FmtOthr|string |error message}} }} {{FmtExpr|else}} {{FmtSubT|1= {{FmtBits|16|bits|block size}} {{FmtOthr|data |data stream, {block size} bytes long}} }} }} {{FmtExpr|else}} {{FmtSubT|1= {{FmtBits|16|bits|block size}} {{FmtOthr|data |data stream, {block size} bytes long}} }} }} === snapshot === {{FormatTable|1= {{FmtBits|8 |bits|'''0x07''' snapshot indicator}} {{FmtBits|32|bits|server time}} {{FmtBits|8 |bits|last frame num}} {{FmtBits|8 |bits|snapshot flag bits}} {{FmtBits|8 |bits|area mask size}} {{FmtOthr|data |area mask, {area mask size} bytes long}} {{FmtSubF|<[[#player-state|player-state]]>}} {{FmtSubF|<[[#entity|entity]]>*}} {{FmtBits|10|bits|'''0x3FF''' end of entities indicator}} }} === entity === {{FormatTable|1= {{FmtBits|10|bits|entity ID}} {{FmtBits|1 |bit |removed-entity indicator}} {{FmtExpr|if removed-entity !&#61; 0x1:}} {{FmtSubT|1= {{FmtBits|1 |bit |changed-entity indicator}} {{FmtExpr|if changed-entity &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtBits|8 |bits|max changed field index}} {{FmtExpr|loop {max changed field index} times:}} {{FmtSubT|1= {{FmtBits|1 |bit |changed-field indicator}} {{FmtExpr|if changed-field &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtBits|1 |bit |is-not-zero indicator}} {{FmtExpr|if is-not-zero &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtSubF|<[[#int-value|int-value]]> &#124; <[[#float-value|float-value]]> // choice depends on field index}} }} {{FmtExpr|else:}} {{FmtSubT|1= {{FmtExpr|// value &#61; 0}} }} }} }} }} }} }} === int-value === {{FormatTable|1= {{FmtBits|N |bits|value, where N depends on field index}} }} === float-value === {{FormatTable|1= {{FmtBits|1 |bit |full-float indicator}} {{FmtExpr|if full-float &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtBits|32|bits|value, as C float}} }} {{FmtExpr|else:}} {{FmtSubT|1= {{FmtBits|13|bits|value, as unsigned int; subtract (1<<12) to return signed int}} }} }} If a field has floating point values, but its current value is a small integer (< &plusmn;4096) without a fractional part, then it is transmitted as a 13-bit unsigned integer instead of transmitting it as a full 32-bit float. To convert a small signed integer that is between -4096 and 4095 to a 13-bit unsigned integer, we simply add 4096 (1<<12) to the number before we send it and then subtract 4096 after it's received. === player-state === {{FormatTable|1= {{FmtBits|8 |bits|max changed field index}} {{FmtExpr|loop {max changed field index} times:}} {{FmtSubT|1= {{FmtBits|1 |bit |changed-field indicator}} {{FmtExpr|if changed-field &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtSubF|<[[#int-value|int-value]]> &#124; <[[#float-value|float-value]]> // choice depends on field index}} }} }} {{FmtBits|1 |bit |changed-state indicator}} {{FmtExpr|if changed-state &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtSubF|<[[#values|values]]> // player stats}} {{FmtSubF|<[[#values|values]]> // persistent player stats}} {{FmtSubF|<[[#values|values]]> // weapon ammo}} {{FmtSubF|<[[#values|values]]> // power-up timeouts}} }} }} === values === {{FormatTable|1= {{FmtBits|1 |bit |changed-values indicator}} {{FmtExpr|if changed-values &#61;&#61; 0x1:}} {{FmtSubT|1= {{FmtBits|16|bits|changed value bitmask}} {{FmtExpr|loop for each bit set in {changed value bitmask}:}} {{FmtSubT|1= {{FmtBits|16|bits|value}} }} }} }} == See also == * [[Netchan message]] * [[Client message format]]

Return to Server message format.