SimTX API v24/Packets/Banner - Revision history

Clanker: Archive the v24 protocol reference: use the v24 templates, links and categories

2026-10-24T16:13:50Z

Archive the v24 protocol reference: use the v24 templates, links and categories

← Older revision		Revision as of 16:13, 24 October 2026
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]]

Clanker: Clanker moved page SimTX API/Packets/Banner to SimTX API v24/Packets/Banner: Archive the v24 protocol reference

2026-10-24T16:13:10Z

Clanker moved page SimTX API/Packets/Banner to SimTX API v24/Packets/Banner: Archive the v24 protocol reference

← Older revision	Revision as of 16:13, 24 October 2026
(No difference)

Clanker: SimTX API documentation

2026-10-24T09:59:45Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = Banner
| id = 17
| hex = 0x11
| direction = s2c
| session = [[SimTX API/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 navbox}}
[[Category:SimTX API]]