← Back to Index
TextPacket (9)
Represents a text message that needs to be displayed in-game
Used for commands, messages, and other info printed to the screen. Most of which are server->client or server broadcasted to all clients, but some cases have a client to other client via the server
| Field Name |
Type |
Field Index |
Description |
| Localize? (Required) |
boolean |
0 |
|
| Body (Required) |
oneOf |
1 |
Message content (variant based on message type) |
oneOf<MessageOnly, AuthorAndMessage, MessageAndParams>:
| Control Value [uint32] |
Type |
Details |
| 0 |
MessageOnly |
- |
| 1 |
AuthorAndMessage |
- |
| 2 |
MessageAndParams |
- |
MessageOnly (Variant 0)
| Field Name |
Type |
Field Index |
Description |
| Message Type (Required) |
varuint8 |
0 |
|
Enum Values:
| Index |
Value |
| 0 |
raw |
| 1 |
tip |
| 2 |
systemMessage |
| 3 |
textObjectWhisper |
| 4 |
textObject |
| 5 |
textObjectAnnouncement |
|
| Message |
string |
1 |
|
AuthorAndMessage (Variant 1)
| Field Name |
Type |
Field Index |
Description |
| Message Type (Required) |
varuint8 |
0 |
|
Enum Values:
| Index |
Value |
| 0 |
chat |
| 1 |
whisper |
| 2 |
announcement |
|
| Player Name |
string |
1 |
|
| Message |
string |
2 |
|
MessageAndParams (Variant 2)
| Field Name |
Type |
Field Index |
Description |
| Message Type (Required) |
varuint8 |
0 |
|
Enum Values:
| Index |
Value |
| 0 |
translate |
| 1 |
popup |
| 2 |
jukeboxPopup |
|
| Message |
string |
1 |
|
| Parameter List |
array<string> |
2 |
|
|
| Sender's XUID |
string |
2 |
Xbox User ID of the message sender |
| Platform Id |
string |
3 |
Platform-specific user identifier |
| Filtered Message |
string |
4 |
Profanity-filtered version of the message (if applicable) |