SimTX API/Packets/BroadcastBanner
| Frame | ClientFrame, field 62
|
|---|---|
| Member | broadcast_banner
|
| Direction | Client → server |
| Session | Moderation |
| Roles | ROLE_MODERATION.
|
| Permission | moderation.manage
|
| Defined in | control.proto
|
BroadcastBanner sets, replaces or clears the server-wide notice. The server pushes the result to every control session as a Banner. There is no reply on success; a refusal is answered with Error.
Definition[edit | edit source]
message BroadcastBanner { int64 request_id = 1; string text = 2; int64 duration_seconds = 3; }
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | request_id |
int64 |
Nonzero. Echoed only by an Error; success has no reply. |
| 2 | text |
string |
Notice text, truncated to 512 characters. Empty clears the current notice. |
| 3 | duration_seconds |
int64 |
How long the notice stays. 0 or less = no expiry. |