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.
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 0.9.22.16–0.9.25.35
Command 157 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 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 any element but 0, 1 and 2. |
Vectors (1)
In 0.9.25.36–1.0.0.24
Command 155 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 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. |
HudHighlightToggled
What a server sends to light up part of the screen, or to put it out. The header carries zero.
In 0.9.25.21–0.9.25.35
Command 166 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 0.9.25.36–1.0.0.24
Command 164 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 | 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. |
UnitHighlighted
What a server sends to outline a unit with a pulsing light, as a tutorial does, until UnitHighlightRemoved. The header carries zero.
In 0.9.22.14–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.14–0.9.25.35 | 142 |
| 0.9.25.36–1.0.0.24 | 141 |
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The unit: one that can be damaged. |
Vectors (1)
UnitHighlightRemoved
What a server sends to take away the light UnitHighlighted put on a unit. The header carries zero.
In 0.9.22.14–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.14–0.9.25.35 | 143 |
| 0.9.25.36–1.0.0.24 | 142 |
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The unit. Where it has no light, nothing happens. |
Vectors (1)
MinimapHighlighted
What a server sends to make part of the minimap blink, as a tutorial does.
In 0.9.25.21–0.9.25.35
Command 165 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| element | u8 | Which part of the minimap blinks. 0 is its camera button, and a server sends only 0; any other value has no defined effect. |
Vectors (1)
In 0.9.25.36–1.0.0.24
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. |
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 0.9.22.16–0.9.25.20
Command 158 on events, sent by the server, reliable.
| 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, and 3 the item second names within the category number names. A client fails for any larger value. |
| 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 (1)
In 0.9.25.21–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.25.21–0.9.25.35 | 158 |
| 0.9.25.36–1.0.0.24 | 156 |
| 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. |
Vectors (1)
ObjectiveShown
What a server sends to show the objective panel with a text. The header carries zero.
In 0.9.22.16–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.16–0.9.25.35 | 151 |
| 0.9.25.36–1.0.0.24 | 149 |
| Field | Type | What it is |
|---|---|---|
| text | text, ended by a zero byte | The objective, ended by a zero byte. |
Vectors (1)
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 0.9.22.16–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.16–0.9.25.35 | 153 |
| 0.9.25.36–1.0.0.24 | 151 |
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. |
Vectors (1)
ObjectiveHidden
What a server sends to hide the objective panel. It carries nothing of its own. The header carries zero.
In 0.9.22.16–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.16–0.9.25.35 | 152 |
| 0.9.25.36–1.0.0.24 | 150 |
No body.
Vectors (1)
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 0.9.22.16–0.9.25.35
Command 154 on events, sent by the server, reliable.
A client also sizes the panel to the text and shows it low on the screen: its edge at 98.5% of the screen’s width, and 85% of the screen’s height less the height of one interface element, scaled by the screen’s width over 1680.
| 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 0.9.25.36–1.0.0.24
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. |
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 0.9.22.16–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.16–0.9.25.35 | 156 |
| 0.9.25.36–1.0.0.24 | 154 |
| 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)
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 0.9.22.16–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.16–0.9.25.35 | 155 |
| 0.9.25.36–1.0.0.24 | 153 |
No body.
Vectors (1)
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 0.9.25.21–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.25.21–0.9.25.35 | 167 |
| 0.9.25.36–1.0.0.24 | 165 |
| 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)
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 0.9.22.14–0.9.22.15
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 popup’s body. A client copies the whole field first, so the text ends at a zero byte within it. |
Vectors (1)
In 0.9.22.16–1.0.0.24
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.16–0.9.25.35 | 144 |
| 0.9.25.36–1.0.0.24 | 143 |
| 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 (1)
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 0.9.22.14–1.0.0.24
Carried on requests, sent by the client, reliable, under these commands:
| Builds | Command |
|---|---|
| 0.9.22.14–0.9.25.35 | 145 |
| 0.9.25.36–1.0.0.24 | 144 |
No body.