SimTX API v24/Packets/Banner: Difference between revisions
SimTX API documentation |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = Banner | | name = Banner | ||
| id = 17 | | id = 17 | ||
| hex = 0x11 | | hex = 0x11 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Control session|Control]] | | session = [[SimTX API v24/Control session|Control]] | ||
| size = 11 + text length | | size = 11 + text length | ||
| permission = None | | permission = None | ||
| Line 32: | Line 32: | ||
* The server also posts short automatic notices when it is overloaded. They clear themselves after about a minute. | * The server also posts short automatic notices when it is overloaded. They clear themselves after about a minute. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:13, 24 October 2026
| Packet ID | 17(0x11)
|
|---|---|
| Direction | Server → client |
| Session | Control |
| Body size | 11 + text length |
| Permission | None |
Banner carries a server-wide notice for control clients to display, such as planned maintenance, a performance warning, or a ban notice. The server sends it when a control session starts, if a notice is active, and pushes it to every control session whenever a notice is set, replaced or cleared.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 17.
|
level |
u8 |
0 = information, 1 = ban notice.
|
text |
UTF |
Notice text, at most 512 characters. Empty means clear the current notice. |
expiresAtEpochMillis |
i64 |
Unix time in milliseconds after which the notice should be hidden. 0 means no expiry.
|
Usage[edit | edit source]
- Show the text prominently, replacing any earlier banner. Each Banner supersedes the previous one.
- Hide the banner when
textis empty. - Hide it at
expiresAtEpochMillis. The server does not send a clearing banner when a notice expires. - A level 1 banner is sent to control sessions from an address that has just been banned. The text explains the ban. Those control sessions stay connected so that the user can read it; new game connections from the address are refused.
- The server also posts short automatic notices when it is overloaded. They clear themselves after about a minute.