Tutorial and guidance
What a server shows a player to lead them: tips, quests, objectives and text at the side of the screen, highlights, and the tutorial.
A server tells a champion something has come about with Situation.
Highlights
A server lights up parts of the screen and units with HudHighlighted,
HudHighlightToggled, UiHighlight, UnitHighlighted and
UnitHighlightRemoved, and makes part of the minimap or of the shop blink with
MinimapHighlighted and ShopHighlighted.
Tips, quests and objectives
A server puts a tip in front of a player with TipShown, addressed to that
player’s champion, and a client reports a click on it, or the tip being closed,
with TipEvent. A server can add, complete and remove quests in the quest
tracker with QuestUpdated, and a client reports the pointer passing over a
quest, and a click on it, with QuestEvent. A server can also show, change
and hide an objective panel (ObjectiveShown, ObjectiveReplaced,
ObjectiveHidden) and a box of text at the side of the screen
(SideTextShown, SideTextRefreshed, SideTextHidden).
The tutorial
In the tutorial, a server can put lines of the client’s own text in its chat
(TutorialChatLine) and open the tutorial’s popup (TutorialPopup), which the
client answers with TutorialPopupClosed.
In 1.0.0.58–1.0.0.129
A client takes
TutorialChatLinein any match.
In 1.0.0.58–1.0.0.96
A client takes
TutorialPopupin any match.
Messages
Each message of this system in this book, with each layout it has across the book’s patches and every note its definition carries. A layout is the message’s body, after the header its channel’s family puts in front (see Messages).
HudHighlighted
What a server sends to light up part of the screen, as a tutorial does. Only HudHighlightToggled turns it off. The header carries zero.
In 1.0.0.25–1.0.0.110
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 155 |
| 1.0.0.74–1.0.0.81 | 156 |
| 1.0.0.82–1.0.0.96 | 160 |
| 1.0.0.97 | 161 |
| 1.0.0.98–1.0.0.102 | 162 |
| 1.0.0.103 | 164 |
| 1.0.0.104–1.0.0.106 | 170 |
| 1.0.0.107–1.0.0.108 | 171 |
| 1.0.0.109 | 172 |
| 1.0.0.110 | 63 |
| Field | Type | What it is |
|---|---|---|
| element | u8 | What to light up on the main controls, 0 to 8; a larger value has no defined effect. 4, 5 and 6 each name a part of a second panel; which part each value names is not recorded. Values: 0 spell, 1 spellUpgrade, 2 summonerSpell, 3 recall, 4 shop, 5 gold, 6 experience, 7 health, 8 mana. |
| number | u8 | Which slot, for a spell or a summoner spell; it has no effect for 4, 5 or 6. |
In 1.0.0.111–1.0.0.123
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.111–1.0.0.116 | 63 |
| 1.0.0.117–1.0.0.118 | 64 |
| 1.0.0.119–1.0.0.123 | 65 |
| Field | Type | What it is |
|---|---|---|
| element | u8 | What to light up on the main controls, 0 to 8; a client ignores a larger value. 4, 5 and 6 each name a part of a second panel; which part each value names is not recorded. Values: 0 spell, 1 spellUpgrade, 2 summonerSpell, 3 recall, 4 shop, 5 gold, 6 experience, 7 health, 8 mana. |
| number | u8 | Which slot, for a spell or a summoner spell; it has no effect for 4, 5 or 6. |
Vectors (3)
In 1.0.0.124–1.0.0.127
Command 67 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | What to light up on the main controls, 0 to 8; a client ignores a larger value. 4, 5 and 6 each name a part of a second panel; which part each value names is not recorded. Values: 0 spell, 1 spellUpgrade, 2 summonerSpell, 3 recall, 4 shop, 5 gold, 6 experience, 7 health, 8 mana. |
| number | u8 | Which slot, for a spell or a summoner spell; it has no effect for 3 to 8. |
Vectors (1)
In 1.0.0.128–1.0.0.129
Command 67 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | What to light up on the main controls. A client ignores any value above 8. Values: 0 spell, 1 spellUpgrade, 2 summonerSpell, 3 recall, 4 shop, 5 gold, 6 experience, 7 health, 8 mana. |
| number | u8 | Which slot, for a spell or a summoner spell; it has no effect otherwise. A client accepts any value, and a slot beyond those named has no defined effect. |
HudHighlightToggled
What a server sends to light up part of the screen, or to put it out. The header carries zero.
In 1.0.0.25–1.0.0.81
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 164 |
| 1.0.0.74–1.0.0.81 | 165 |
| Field | Type | What it is |
|---|---|---|
| part | u8 | Which part of the screen. A client ignores any other value. Values: 1 hud, 2 shop, 3 minimap. |
| element | u8 | What to light up, as in HudHighlighted. A value beyond those named does nothing. |
| number | u8 | Which slot, as in HudHighlighted. |
| second | u8 | A third value where part is 2; a server writes zero otherwise. |
| state | 1-byte bits | Whether it is lit. |
| state.on | bit 0 | Set to light it up, clear to put it out. |
| state.unused | bit 1 to 7 | A client ignores these bits; a server writes zero. |
Vectors (3)
In 1.0.0.82–1.0.0.96
Command 169 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| part | u8 | Which part of the screen. A client ignores any other value. Values: 1 hud, 2 shop, 3 minimap. |
| element | u8 | What to light up, as in HudHighlighted. A value beyond those named has no defined effect. |
| number | u8 | Which slot, as in HudHighlighted. |
| second | u8 | A third value where part is 2; a server writes zero otherwise. |
| state | 1-byte bits | Whether it is lit. |
| state.on | bit 0 | Set to light it up, clear to put it out. |
| state.unused | bit 1 to 7 | A client ignores these bits; a server writes zero. |
Vectors (1)
In 1.0.0.97–1.0.0.123
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.97 | 170 |
| 1.0.0.98–1.0.0.102 | 171 |
| 1.0.0.103 | 173 |
| 1.0.0.104–1.0.0.106 | 179 |
| 1.0.0.107–1.0.0.108 | 180 |
| 1.0.0.109 | 181 |
| 1.0.0.110–1.0.0.116 | 78 |
| 1.0.0.117–1.0.0.118 | 79 |
| 1.0.0.119–1.0.0.123 | 80 |
| Field | Type | What it is |
|---|---|---|
| part | u8 | Which part of the screen. A client ignores any other value. Values: 1 hud, 2 shop, 3 minimap. |
| element | u8 | What to light up, as in HudHighlighted. A value beyond those named does nothing. |
| number | u8 | Which slot, as in HudHighlighted. |
| second | u8 | A third value where part is 2; a server writes zero otherwise. |
| state | 1-byte bits | Whether it is lit. |
| state.on | bit 0 | Set to light it up, clear to put it out. |
| state.unused | bit 1 to 7 | A client ignores these bits; a server writes zero. |
In 1.0.0.124–1.0.0.127
Command 82 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| part | u8 | Which part of the screen. A client ignores any other value. Values: 1 hud, 2 shop, 3 minimap. |
| element | u8 | What to light up, as in HudHighlighted. A client checks it against no limit: a value beyond those named has no defined effect. |
| number | u8 | Which slot, as in HudHighlighted. |
| second | u8 | A third value where part is 2; a server writes zero otherwise. |
| state | 1-byte bits | Whether it is lit. |
| state.on | bit 0 | Set to light it up, clear to put it out. |
| state.unused | bit 1 to 7 | A client ignores these bits; a server writes zero. |
Vectors (1)
In 1.0.0.128–1.0.0.129
Command 82 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| part | u8 | Which part of the screen. A client ignores any other value. Values: 1 hud, 2 shop, 3 minimap. |
| element | u8 | What to light up, as in HudHighlighted. A value beyond those named does nothing. |
| number | u8 | Which slot, as in HudHighlighted. |
| second | u8 | For the shop’s element 3, which item within the category; a client reads nothing here otherwise. |
| state | 1-byte bits | Whether it is lit. |
| state.on | bit 0 | Set to light it up, clear to put it out. |
| state.unused | bit 1 to 7 | Unused; a server writes zero. |
UiHighlight
What a server sends to place an animated highlight over one element of the screen, or to take one away. The header carries zero.
In 1.0.0.104–1.0.0.110
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.104–1.0.0.106 | 146 |
| 1.0.0.107–1.0.0.108 | 147 |
| 1.0.0.109 | 148 |
| 1.0.0.110 | 200 |
| Field | Type | What it is |
|---|---|---|
| action | u8 | What to do. A client does nothing for 2 and up. Values: 0 show, 1 remove. |
| element | u8 | Which element. Showing a value above 14 has no defined effect. Values: 0 minimap, 1 quests, 2 tips, 3 characterInfo, 4 effects, 5 ultimate, 6 recall, 7 shop, 8 spellPoint1, 9 gold, 10 assists, 11 passive, 12 spellPoint2, 13 spellPoint3, 14 spellPoint4. |
Vectors (4)
show-on-1-0-0-106, show-on-1-0-0-108, show-on-1-0-0-109, show-on-1-0-0-110
In 1.0.0.111–1.0.0.129
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.111–1.0.0.116 | 201 |
| 1.0.0.117–1.0.0.118 | 202 |
| 1.0.0.119–1.0.0.122 | 203 |
| 1.0.0.123 | 204 |
| 1.0.0.124 | 209 |
| 1.0.0.125 | 210 |
| 1.0.0.126–1.0.0.129 | 211 |
| Field | Type | What it is |
|---|---|---|
| action | u8 | What to do. A client takes 2 to 14 and does nothing, and ignores the message from 15 up. Values: 0 show, 1 remove. |
| element | u8 | Which element. Showing a value above 14 has no defined effect. Values: 0 minimap, 1 quests, 2 tips, 3 characterInfo, 4 effects, 5 ultimate, 6 recall, 7 shop, 8 spellPoint1, 9 gold, 10 assists, 11 passive, 12 spellPoint2, 13 spellPoint3, 14 spellPoint4. |
UnitHighlighted
What a server sends to outline a unit with a pulsing light, as a tutorial does, until UnitHighlightRemoved. The header carries zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 141 |
| 1.0.0.74–1.0.0.81 | 142 |
| 1.0.0.82–1.0.0.96 | 146 |
| 1.0.0.97 | 147 |
| 1.0.0.98–1.0.0.102 | 148 |
| 1.0.0.103 | 150 |
| 1.0.0.104–1.0.0.106 | 155 |
| 1.0.0.107–1.0.0.108 | 156 |
| 1.0.0.109 | 157 |
| 1.0.0.110–1.0.0.116 | 87 |
| 1.0.0.117–1.0.0.118 | 88 |
| 1.0.0.119–1.0.0.123 | 89 |
| 1.0.0.124–1.0.0.129 | 92 |
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The unit: one that can be damaged. |
UnitHighlightRemoved
What a server sends to take away the light UnitHighlighted put on a unit. The header carries zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 142 |
| 1.0.0.74–1.0.0.81 | 143 |
| 1.0.0.82–1.0.0.96 | 147 |
| 1.0.0.97 | 148 |
| 1.0.0.98–1.0.0.102 | 149 |
| 1.0.0.103 | 151 |
| 1.0.0.104–1.0.0.106 | 156 |
| 1.0.0.107–1.0.0.108 | 157 |
| 1.0.0.109 | 158 |
| 1.0.0.110 | 179 |
| 1.0.0.111–1.0.0.116 | 180 |
| 1.0.0.117–1.0.0.118 | 181 |
| 1.0.0.119–1.0.0.123 | 182 |
| 1.0.0.124 | 186 |
| 1.0.0.125 | 187 |
| 1.0.0.126–1.0.0.129 | 188 |
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The unit. Where it has no light, nothing happens. |
Vectors (17)
one-on-1-0-0-72, one-on-1-0-0-75, one-on-1-0-0-81, one-on-1-0-0-96, one-on-1-0-0-97, one-on-1-0-0-99, one-on-1-0-0-103, one-on-1-0-0-106, one-on-1-0-0-108, one-on-1-0-0-109, one-on-1-0-0-110, one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-124, one-on-1-0-0-125, one-on-1-0-0-126
MinimapHighlighted
What a server sends to make part of the minimap blink, as a tutorial does.
In 1.0.0.25–1.0.0.73
Command 163 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | Which part of the minimap blinks; a server sends 0, its camera button. A client acts only once it knows its own champion, and does not check the value: any other has no defined effect. |
Vectors (1)
In 1.0.0.74–1.0.0.81
Command 164 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | Which part of the minimap blinks. A client acts on 0 alone, its camera button, and only once it knows its own champion; it ignores any other value. |
Vectors (2)
In 1.0.0.82–1.0.0.96
Command 168 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | Which part of the minimap blinks; a server sends 0, its camera button. A client acts only once it knows its own champion, and does not check the value: any other has no defined effect. |
Vectors (1)
In 1.0.0.97–1.0.0.127
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.97 | 169 |
| 1.0.0.98–1.0.0.102 | 170 |
| 1.0.0.103 | 172 |
| 1.0.0.104–1.0.0.106 | 178 |
| 1.0.0.107–1.0.0.108 | 179 |
| 1.0.0.109 | 180 |
| 1.0.0.110–1.0.0.127 | 20 |
| Field | Type | What it is |
|---|---|---|
| element | u8 | Which part of the minimap blinks. A client acts on 0 alone, its camera button, and only once it knows its own champion; it ignores any other value. |
In 1.0.0.128–1.0.0.129
Command 20 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | The minimap; a client acts on element 0 only, its camera button, and only once it knows its own champion. Any other value is ignored. |
ShopHighlighted
What a server sends to make a shop element blink once, as a tutorial does. The header names no object: a server writes zero.
In 1.0.0.25–1.0.0.110
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 156 |
| 1.0.0.74–1.0.0.81 | 157 |
| 1.0.0.82–1.0.0.96 | 161 |
| 1.0.0.97 | 162 |
| 1.0.0.98–1.0.0.102 | 163 |
| 1.0.0.103 | 165 |
| 1.0.0.104–1.0.0.106 | 171 |
| 1.0.0.107–1.0.0.108 | 172 |
| 1.0.0.109–1.0.0.110 | 173 |
| Field | Type | What it is |
|---|---|---|
| element | u8 | A shop element blinks once, where the shop window is open. Element 0 is the buy button, 1 the sell button, 2 the shop item number names, 3 the item second names within the category number names, and 4 the recommended item number names. A larger value than 4 has no defined effect. |
| number | u8 | Which of the element’s entries. |
| second | u8 | For the shop’s element 3, which item within the category; a client reads nothing here otherwise. |
In 1.0.0.111–1.0.0.129
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.111–1.0.0.116 | 174 |
| 1.0.0.117–1.0.0.118 | 175 |
| 1.0.0.119–1.0.0.123 | 176 |
| 1.0.0.124 | 180 |
| 1.0.0.125 | 181 |
| 1.0.0.126–1.0.0.129 | 182 |
| Field | Type | What it is |
|---|---|---|
| element | u8 | A shop element blinks once, where the shop window is open. Element 0 is the buy button, 1 the sell button, 2 the shop item number names, 3 the item second names within the category number names, and 4 the recommended item number names. A client ignores any value above 4. |
| number | u8 | Which of the element’s entries. |
| second | u8 | For the shop’s element 3, which item within the category; a client reads nothing here otherwise. |
Vectors (5)
one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-124, one-on-1-0-0-125
TipShown
What a server sends to put a note in front of a seat. The header names the champion of the player it is sent to.
In 1.0.0.104–1.0.0.129
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.104–1.0.0.106 | 145 |
| 1.0.0.107–1.0.0.108 | 146 |
| 1.0.0.109 | 147 |
| 1.0.0.110–1.0.0.116 | 84 |
| 1.0.0.117–1.0.0.118 | 85 |
| 1.0.0.119–1.0.0.123 | 86 |
| 1.0.0.124–1.0.0.129 | 88 |
| Field | Type | What it is |
|---|---|---|
| body | text, 128 bytes | What the note says. Written out in full and padded with zero bytes to the width above. |
| heading | text, 128 bytes | What the note is headed with, written and padded as above. |
| image | text, 128 bytes | The name the client loads a picture for the note under, written and padded as above. |
| what | u8 | What the client does with the note. |
| tip | u32 | The name this note answers to, so a later message can name it. |
TipEvent
What a client sends about a tip it has shown or dismissed.
In 1.0.0.104–1.0.0.125
Carried on requests, sent by the client, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.104–1.0.0.106 | 147 |
| 1.0.0.107–1.0.0.108 | 148 |
| 1.0.0.109 | 149 |
| 1.0.0.110 | 106 |
| 1.0.0.111–1.0.0.116 | 107 |
| 1.0.0.117–1.0.0.118 | 108 |
| 1.0.0.119–1.0.0.123 | 109 |
| 1.0.0.124–1.0.0.125 | 112 |
| Field | Type | What it is |
|---|---|---|
| what | u8 | What happened to the tip. Values: 0 clicked, 1 closed. |
| tip | u32 | Which tip, as TipShown named it. |
In 1.0.0.126–1.0.0.129
Command 112 on requests, sent by the client, reliable.
Where what is 0, the header names the champion the TipShown named; where it is 1, the sender’s champion.
| Field | Type | What it is |
|---|---|---|
| what | u8 | What happened to the tip. Values: 0 clicked, 1 closed. |
| tip | u32 | Which tip, as TipShown named it. |
Vectors (1)
QuestUpdated
What a server sends to add a quest to the quest tracker, complete it or remove it. The header carries zero.
In 1.0.0.104–1.0.0.123
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.104–1.0.0.106 | 143 |
| 1.0.0.107–1.0.0.108 | 144 |
| 1.0.0.109 | 145 |
| 1.0.0.110 | 136 |
| 1.0.0.111–1.0.0.116 | 137 |
| 1.0.0.117–1.0.0.118 | 138 |
| 1.0.0.119–1.0.0.123 | 139 |
The header names a champion; a client takes the message only so.
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text for the quest. It applies to activate only. |
| icon | text, 128 bytes | The quest’s icon. It applies to activate only. |
| kind | u8 | Which tracker it goes in. A tracker that is full holds a new quest back until it has room. Values: 0 primary, 1 secondary. |
| action | u8 | What to do. A client ignores any other value. Values: 0 activate, 1 complete, 2 remove. |
| flags | 1-byte bits | What a flag means depends on action. |
| flags.first | bit 0 | For activate, set to have the client report the pointer passing over the quest (QuestEvent); for complete, set where the quest succeeded. |
| flags.unused | bit 1 to 7 | Unused; a server writes zero. |
| quest | i32 | The quest’s number, which QuestEvent returns. |
In 1.0.0.124–1.0.0.127
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.124–1.0.0.125 | 143 |
| 1.0.0.126–1.0.0.127 | 144 |
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text for the quest. It applies to activate only. |
| icon | text, 128 bytes | The quest’s icon. It applies to activate only. |
| tooltip | text, 128 bytes | A key into the client’s own text. It applies to activate only. |
| kind | u8 | Which tracker it goes in. A tracker that is full holds a new quest back until it has room. Values: 0 primary, 1 secondary. |
| action | u8 | What to do. A client ignores any other value. Values: 0 activate, 1 complete, 2 remove. |
| flags | 1-byte bits | What a flag means depends on action. |
| flags.first | bit 0 | For activate, set to have the client report the pointer passing over the quest (QuestEvent); for complete, set where the quest succeeded. |
| flags.unused | bit 1 to 7 | Unused; a server writes zero. |
| quest | i32 | The quest’s number, which QuestEvent returns. |
Vectors (2)
In 1.0.0.128–1.0.0.129
Command 144 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text for the quest. It applies to activate only. |
| icon | text, 128 bytes | The quest’s icon. It applies to activate only. |
| tooltip | text, 128 bytes | A key into the client’s own text for its tooltip. It applies to activate only. |
| kind | u8 | Which tracker it goes in. A tracker that is full holds a new quest back until it has room. Values: 0 primary, 1 secondary. |
| action | u8 | What to do. A client ignores any other value. Values: 0 activate, 1 complete, 2 remove. |
| flags | 1-byte bits | What a flag means depends on action. |
| flags.first | bit 0 | For activate, set to have the client report the pointer passing over the quest (QuestEvent); for complete, set where the quest succeeded. |
| flags.unused | bit 1 to 7 | Unused; a server writes zero. |
| quest | i32 | The quest’s number, which QuestEvent returns. |
QuestEvent
What a client sends as its player points at a quest in the tracker (QuestUpdated), stops pointing at it, or clicks it. The header names the sender’s champion.
In 1.0.0.104–1.0.0.129
Carried on requests, sent by the client, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.104–1.0.0.106 | 144 |
| 1.0.0.107–1.0.0.108 | 145 |
| 1.0.0.109 | 146 |
| 1.0.0.110 | 203 |
| 1.0.0.111–1.0.0.116 | 204 |
| 1.0.0.117–1.0.0.118 | 205 |
| 1.0.0.119–1.0.0.122 | 206 |
| 1.0.0.123 | 207 |
| 1.0.0.124 | 212 |
| 1.0.0.125 | 213 |
| 1.0.0.126–1.0.0.129 | 214 |
| Field | Type | What it is |
|---|---|---|
| event | u8 | What the player did. Pointing and leaving are sent only for a quest activated with its first flag set; a click at most once in three seconds. Values: 0 enter, 1 leave, 2 click. |
| quest | i32 | The quest’s number, as QuestUpdated gave it. |
ObjectiveShown
What a server sends to show the objective panel with a text. The header carries zero.
In 1.0.0.25–1.0.0.110
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 149 |
| 1.0.0.74–1.0.0.81 | 150 |
| 1.0.0.82–1.0.0.96 | 154 |
| 1.0.0.97 | 155 |
| 1.0.0.98–1.0.0.102 | 156 |
| 1.0.0.103 | 158 |
| 1.0.0.104–1.0.0.106 | 164 |
| 1.0.0.107–1.0.0.108 | 165 |
| 1.0.0.109 | 166 |
| 1.0.0.110 | 56 |
| Field | Type | What it is |
|---|---|---|
| text | text, ended by a zero byte | The objective, ended by a zero byte. |
In 1.0.0.111–1.0.0.129
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.111–1.0.0.116 | 56 |
| 1.0.0.117–1.0.0.118 | 57 |
| 1.0.0.119–1.0.0.123 | 58 |
| 1.0.0.124–1.0.0.129 | 59 |
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | The objective. The text ends at its first zero byte, which falls within the field. |
Vectors (4)
one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-126
ObjectiveReplaced
What a server sends to replace the text of the objective panel, showing the panel if it is hidden. The header carries zero.
In 1.0.0.25–1.0.0.110
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 151 |
| 1.0.0.74–1.0.0.81 | 152 |
| 1.0.0.82–1.0.0.96 | 156 |
| 1.0.0.97 | 157 |
| 1.0.0.98–1.0.0.102 | 158 |
| 1.0.0.103 | 160 |
| 1.0.0.104–1.0.0.106 | 166 |
| 1.0.0.107–1.0.0.108 | 167 |
| 1.0.0.109 | 168 |
| 1.0.0.110 | 14 |
A client ignores it where it has no objective panel.
| Field | Type | What it is |
|---|---|---|
| text | text, ended by a zero byte | The objective, ended by a zero byte. |
In 1.0.0.111–1.0.0.127
Command 14 on events, sent by the server, reliable.
A client ignores it where it has no objective panel.
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | The objective. The text ends at its first zero byte, which falls within the field. |
Vectors (1)
In 1.0.0.128–1.0.0.129
Command 14 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | The objective. The text ends at its first zero byte, which falls within the field. |
ObjectiveHidden
What a server sends to hide the objective panel. It carries nothing of its own. The header carries zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 150 |
| 1.0.0.74–1.0.0.81 | 151 |
| 1.0.0.82–1.0.0.96 | 155 |
| 1.0.0.97 | 156 |
| 1.0.0.98–1.0.0.102 | 157 |
| 1.0.0.103 | 159 |
| 1.0.0.104–1.0.0.106 | 165 |
| 1.0.0.107–1.0.0.108 | 166 |
| 1.0.0.109 | 167 |
| 1.0.0.110 | 161 |
| 1.0.0.111–1.0.0.116 | 162 |
| 1.0.0.117–1.0.0.118 | 163 |
| 1.0.0.119–1.0.0.123 | 164 |
| 1.0.0.124 | 168 |
| 1.0.0.125 | 169 |
| 1.0.0.126–1.0.0.129 | 170 |
No body.
Vectors (17)
one-on-1-0-0-72, one-on-1-0-0-75, one-on-1-0-0-81, one-on-1-0-0-96, one-on-1-0-0-97, one-on-1-0-0-99, one-on-1-0-0-103, one-on-1-0-0-106, one-on-1-0-0-108, one-on-1-0-0-109, one-on-1-0-0-110, one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-124, one-on-1-0-0-125, one-on-1-0-0-126
SideTextShown
What a server sends to show a box of text at the right edge of the screen. The header names no object: a server writes zero.
In 1.0.0.25–1.0.0.73
Command 152 on events, sent by the server, reliable.
A client also sizes the panel to the text and shows it. The box sits at the lower right, at 98.5% of the screen’s width and 85% of its height, less room for the interface.
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text, which it looks up and shows. The text ends at its first zero byte, which falls within the field. |
Vectors (1)
In 1.0.0.74–1.0.0.129
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.74–1.0.0.81 | 153 |
| 1.0.0.82–1.0.0.96 | 157 |
| 1.0.0.97 | 158 |
| 1.0.0.98–1.0.0.102 | 159 |
| 1.0.0.103 | 161 |
| 1.0.0.104–1.0.0.106 | 167 |
| 1.0.0.107–1.0.0.108 | 168 |
| 1.0.0.109 | 169 |
| 1.0.0.110 | 159 |
| 1.0.0.111–1.0.0.116 | 160 |
| 1.0.0.117–1.0.0.118 | 161 |
| 1.0.0.119–1.0.0.123 | 162 |
| 1.0.0.124 | 166 |
| 1.0.0.125 | 167 |
| 1.0.0.126–1.0.0.129 | 168 |
A client also sizes the panel to the text and shows it. The box sits halfway down the screen.
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text, which it looks up and shows. The text ends at its first zero byte, which falls within the field. |
SideTextRefreshed
What a server sends to change the text in the box SideTextShown opened, in place. The header names no object: a server writes zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 154 |
| 1.0.0.74–1.0.0.81 | 155 |
| 1.0.0.82–1.0.0.96 | 159 |
| 1.0.0.97 | 160 |
| 1.0.0.98–1.0.0.102 | 161 |
| 1.0.0.103 | 163 |
| 1.0.0.104–1.0.0.106 | 169 |
| 1.0.0.107–1.0.0.108 | 170 |
| 1.0.0.109 | 171 |
| 1.0.0.110 | 176 |
| 1.0.0.111–1.0.0.116 | 177 |
| 1.0.0.117–1.0.0.118 | 178 |
| 1.0.0.119–1.0.0.123 | 179 |
| 1.0.0.124 | 183 |
| 1.0.0.125 | 184 |
| 1.0.0.126–1.0.0.129 | 185 |
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text, which it looks up and shows. The text ends at its first zero byte, which falls within the field. |
Vectors (17)
one-on-1-0-0-72, one-on-1-0-0-75, one-on-1-0-0-81, one-on-1-0-0-96, one-on-1-0-0-97, one-on-1-0-0-99, one-on-1-0-0-103, one-on-1-0-0-106, one-on-1-0-0-108, one-on-1-0-0-109, one-on-1-0-0-110, one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-124, one-on-1-0-0-125, one-on-1-0-0-126
SideTextHidden
What a server sends to close the box of text SideTextShown opened. It carries nothing of its own. The header names no object: a server writes zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 153 |
| 1.0.0.74–1.0.0.81 | 154 |
| 1.0.0.82–1.0.0.96 | 158 |
| 1.0.0.97 | 159 |
| 1.0.0.98–1.0.0.102 | 160 |
| 1.0.0.103 | 162 |
| 1.0.0.104–1.0.0.106 | 168 |
| 1.0.0.107–1.0.0.108 | 169 |
| 1.0.0.109 | 170 |
| 1.0.0.110 | 166 |
| 1.0.0.111–1.0.0.116 | 167 |
| 1.0.0.117–1.0.0.118 | 168 |
| 1.0.0.119–1.0.0.123 | 169 |
| 1.0.0.124 | 173 |
| 1.0.0.125 | 174 |
| 1.0.0.126–1.0.0.129 | 175 |
No body.
Vectors (17)
one-on-1-0-0-72, one-on-1-0-0-75, one-on-1-0-0-81, one-on-1-0-0-96, one-on-1-0-0-97, one-on-1-0-0-99, one-on-1-0-0-103, one-on-1-0-0-106, one-on-1-0-0-108, one-on-1-0-0-109, one-on-1-0-0-110, one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-124, one-on-1-0-0-125, one-on-1-0-0-126
TutorialChatLine
What a server sends to put a line of the client’s own text in its chat, as a line from the game. The header carries zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 165 |
| 1.0.0.74–1.0.0.81 | 166 |
| 1.0.0.82–1.0.0.96 | 170 |
| 1.0.0.97 | 171 |
| 1.0.0.98–1.0.0.102 | 172 |
| 1.0.0.103 | 174 |
| 1.0.0.104–1.0.0.106 | 180 |
| 1.0.0.107–1.0.0.108 | 181 |
| 1.0.0.109 | 182 |
| 1.0.0.110–1.0.0.129 | 2 |
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text, which it looks up and shows. The text ends at its first zero byte, which falls within the field. |
TutorialPopup
What a server sends to open the tutorial’s popup: a caption, this text and a single button, which a client answers with TutorialPopupClosed. A client has one such popup; a second message replaces its text. The header carries zero.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.25–1.0.0.73 | 143 |
| 1.0.0.74–1.0.0.81 | 144 |
| 1.0.0.82–1.0.0.96 | 148 |
| 1.0.0.97 | 149 |
| 1.0.0.98–1.0.0.102 | 150 |
| 1.0.0.103 | 152 |
| 1.0.0.104–1.0.0.106 | 157 |
| 1.0.0.107–1.0.0.108 | 158 |
| 1.0.0.109 | 159 |
| 1.0.0.110 | 178 |
| 1.0.0.111–1.0.0.116 | 179 |
| 1.0.0.117–1.0.0.118 | 180 |
| 1.0.0.119–1.0.0.123 | 181 |
| 1.0.0.124 | 185 |
| 1.0.0.125 | 186 |
| 1.0.0.126–1.0.0.129 | 187 |
| Field | Type | What it is |
|---|---|---|
| text | text, 128 bytes | A key into the client’s own text for the popup’s body. The text ends at its first zero byte, which falls within the field. |
Vectors (17)
one-on-1-0-0-72, one-on-1-0-0-75, one-on-1-0-0-81, one-on-1-0-0-96, one-on-1-0-0-97, one-on-1-0-0-99, one-on-1-0-0-103, one-on-1-0-0-106, one-on-1-0-0-108, one-on-1-0-0-109, one-on-1-0-0-110, one-on-1-0-0-116, one-on-1-0-0-117, one-on-1-0-0-123, one-on-1-0-0-124, one-on-1-0-0-125, one-on-1-0-0-126
TutorialPopupClosed
What a client sends as its player presses the button of the tutorial’s popup (TutorialPopup). It carries nothing of its own. The header carries zero.
In 1.0.0.74–1.0.0.81
Command 145 on requests, sent by the client, reliable.
A client also sends it as its player closes a tip in the tutorial.
No body.
Vectors (2)
In 1.0.0.97–1.0.0.125
Carried on requests, sent by the client, reliable, under these commands:
| Builds | Command |
|---|---|
| 1.0.0.97 | 150 |
| 1.0.0.98–1.0.0.102 | 151 |
| 1.0.0.103 | 153 |
| 1.0.0.104–1.0.0.106 | 158 |
| 1.0.0.107–1.0.0.108 | 159 |
| 1.0.0.109 | 160 |
| 1.0.0.110 | 202 |
| 1.0.0.111–1.0.0.116 | 203 |
| 1.0.0.117–1.0.0.118 | 204 |
| 1.0.0.119–1.0.0.122 | 205 |
| 1.0.0.123 | 206 |
| 1.0.0.124 | 211 |
| 1.0.0.125 | 212 |
A client also sends it as its player closes a tip in the tutorial.
No body.