SimTX API v24/Packets/TxKick: Difference between revisions
m Clanker moved page SimTX API/Packets/TxKick to SimTX API v24/Packets/TxKick: Archive the v24 protocol reference |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = TxKick | | name = TxKick | ||
| id = 6 | | id = 6 | ||
| hex = 0x06 | | hex = 0x06 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Transmitter session|Transmitter]] | | session = [[SimTX API v24/Transmitter session|Transmitter]] | ||
| size = 2 + reason length | | size = 2 + reason length | ||
| permission = None | | permission = None | ||
| Line 26: | Line 26: | ||
* Not every disconnect is announced with TxKick. Expiry of the account lease and changes to the account close the connection silently. | * Not every disconnect is announced with TxKick. Expiry of the account lease and changes to the account close the connection silently. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:18, 24 October 2026
| Packet ID | 6(0x06)
|
|---|---|
| Direction | Server → client |
| Session | Transmitter |
| Body size | 2 + reason length |
| Permission | None |
TxKick tells a transmitter client that its station has been taken off the air by a moderator or the server operator, or because its address was banned. The server closes the connection immediately afterwards.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 6.
|
reason |
UTF |
Human-readable reason. The default is Disconnected by the server administrator. |
Usage[edit | edit source]
- Show the reason to the user.
- Do not reconnect automatically in a tight loop. A kick is a deliberate action by a person.
- Not every disconnect is announced with TxKick. Expiry of the account lease and changes to the account close the connection silently.