Editing SimTX API v24/Packets/Banner

{{SimTX API v24 navigation}}
{{SimTX packet v24
| name = Banner
| id = 17
| hex = 0x11
| direction = s2c
| session = [[SimTX API v24/Control session|Control]]
| size = 11 + text length
| permission = None
| group = control
}}
'''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 ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>17</code>.
|-
| <code>level</code> || <code>u8</code> || <code>0</code> = information, <code>1</code> = ban notice.
|-
| <code>text</code> || <code>UTF</code> || Notice text, at most 512 characters. Empty means ''clear the current notice''.
|-
| <code>expiresAtEpochMillis</code> || <code>i64</code> || Unix time in milliseconds after which the notice should be hidden. <code>0</code> means no expiry.
|}

== Usage ==
* Show the text prominently, replacing any earlier banner. Each Banner supersedes the previous one.
* Hide the banner when <code>text</code> is empty.
* Hide it at <code>expiresAtEpochMillis</code>. 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.

{{SimTX API v24 navbox}}
[[Category:SimTX API v24]]