← 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? 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
raw (Required) string 0
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
tip (Required) string 1
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
systemMessage (Required) string 2
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
textObjectWhisper (Required) string 3
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
textObjectAnnouncement (Required) string 4
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
textObject (Required) string 5
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
Message Type (Required) uint8 6
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
Message string 7
AuthorAndMessage (Variant 1)
Field Name Type Field Index Description
chat (Required) string 0
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
whisper (Required) string 1
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
announcement (Required) string 2
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
Message Type (Required) uint8 3
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
Player Name string 4
Message string 5
MessageAndParams (Variant 2)
Field Name Type Field Index Description
translate (Required) string 0
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
popup (Required) string 1
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
jukeboxPopup (Required) string 2
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
Message Type (Required) uint8 3
Enum Values:
Index Value
0 raw
1 chat
2 translate
3 popup
4 jukeboxPopup
5 tip
6 systemMessage
7 whisper
8 announcement
9 textObjectWhisper
10 textObject
11 textObjectAnnouncement
Message string 4
Parameter List array<string> 5
Sender's XUID (Required) string 2 Xbox User ID of the message sender
Platform Id (Required) string 3 Platform-specific user identifier
Filtered Message string 4 Profanity-filtered version of the message (if applicable)