- summary: The structured links attached to a chat line - items and monster groups - as opposed to the line's words.
- area: Game.Chat
The structured links attached to a chat line - items and monster groups - as opposed to the line's words.
Kind struct · Area Game.Chat
What rides ALONGSIDE a chat line's text. When a player shift-clicks an item or links a
monster group into chat, the visible words stay in the message's content and the
structured link data comes here, so the recipient's client can render the link and
show a tooltip on hover.
It is carried by the chat messages that can hold a link, and it is normally PRESENT BUT EMPTY: an ordinary text line still carries it. Treat an empty one as the common case.
TO SEND A LINK
1. Write the link's text into the message's content (the client writes
{chatitem,<uid>,<gid>} for an item).
2. Add the linked item to Metadata.objects, or the linked monster group to
Metadata.monster_groups. One entry per link.
3. For plain text, send this record empty.
TO READ ONE
Read Metadata.objects for item tooltips and Metadata.monster_groups for
monster-group links. If you only need the words, read content and ignore this.
Not sent on its own — it is only ever carried by a chat message. proven
Used by
ChatChannelMessageEventChatChannelMessageRequestChatPrivateCopyMessageEventChatPrivateMessageRequest
Fields
| # | Field | Type | Meaning | You set it |
|---|---|---|---|---|
| 1 | objects | repeated ObjectItem | The items linked into the line, one per link. Each entry is the item's full ObjectItem (uid, gid, quantity, effects); the line's text carries the matching {chatitem,<uid>,<gid>} marker.Beta carried the same list on the chat message itself, as object. | optional |
| 2 | monster_groups | repeated MonsterGroup | The monster groups linked into the line, one per link. Each entry is a MonsterGroup: position, leader, group id and make-up. | optional |