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.

A client takes TutorialChatLine in 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.130–1.0.0.143

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.131	67
1.0.0.132–1.0.0.143	68

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.

Vectors (2)

spell-on-1-0-0-131, spell-on-1-0-0-143

In 1.0.0.144–3.1.0.0

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.144–1.0.0.149	63
1.0.0.150–3.1.0.0	60

Field	Type	What it is
part	u8	Which part of the screen. A client ignores any other value. Values: 0 hud, 1 shop, 2 minimap.
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.
second	u8	For the shop’s element 3, which item within the category; a client reads nothing here otherwise.

Vectors (1)

hud-on-1-0-0-149

`HudHighlightToggled`

What a server sends to light up part of the screen, or to put it out. 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.130–1.0.0.131	82
1.0.0.132–1.0.0.137	83
1.0.0.138–1.0.0.143	85
1.0.0.144–1.0.0.149	79
1.0.0.150–3.1.0.0	76

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.

Vectors (5)

hud-on-1-0-0-131, hud-on-1-0-0-136, hud-on-1-0-0-143, hud-on-1-0-0-149, hud-on-1-0-0-154

`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 every range of this book

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.131	211
1.0.0.132–1.0.0.134	212
1.0.0.135	214
1.0.0.136–1.0.0.137	212
1.0.0.138	214
1.0.0.139–1.0.0.140	213
1.0.0.141–1.0.0.143	215
1.0.0.144–1.0.0.149	202
1.0.0.150–3.1.0.0	199

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.

Vectors (9)

show-on-1-0-0-131, show-on-1-0-0-134, show-on-1-0-0-135, show-on-1-0-0-136, show-on-1-0-0-138, show-on-1-0-0-140, show-on-1-0-0-143, show-on-1-0-0-149, show-on-1-0-0-154

`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.130–1.0.0.131	92
1.0.0.132–1.0.0.137	93
1.0.0.138–1.0.0.143	95
1.0.0.144–1.0.0.149	89
1.0.0.150–3.1.0.0	86

Field	Type	What it is
unit	u32	The unit: one that can be damaged.

Vectors (5)

one-on-1-0-0-131, one-on-1-0-0-136, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`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.130–1.0.0.131	188
1.0.0.132–1.0.0.134	189
1.0.0.135	191
1.0.0.136–1.0.0.137	189
1.0.0.138	191
1.0.0.139–1.0.0.140	190
1.0.0.141–1.0.0.143	192
1.0.0.144–1.0.0.149	180
1.0.0.150–3.1.0.0	177

Field	Type	What it is
unit	u32	The unit. Where it has no light, nothing happens.

Vectors (9)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138, one-on-1-0-0-140, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`MinimapHighlighted`

What a server sends to make part of the minimap blink, as a tutorial does.

In 1.0.0.130–1.0.0.143

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.

Vectors (1)

one-on-1-0-0-143

`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.130–1.0.0.143

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.131	182
1.0.0.132–1.0.0.134	183
1.0.0.135	185
1.0.0.136–1.0.0.137	183
1.0.0.138	185
1.0.0.139–1.0.0.140	184
1.0.0.141–1.0.0.143	186

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 (7)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138, one-on-1-0-0-140, one-on-1-0-0-143

`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 every range of this book

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.131	88
1.0.0.132–1.0.0.137	89
1.0.0.138–1.0.0.143	91
1.0.0.144–1.0.0.149	85
1.0.0.150–3.1.0.0	82

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.

Vectors (5)

one-on-1-0-0-131, one-on-1-0-0-136, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`TipEvent`

What a client sends about a tip it has shown or dismissed.

In 1.0.0.130–1.0.0.131

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)

clicked-on-1-0-0-131

In 1.0.0.132–1.0.0.137

Command 113 on requests, sent by the client, reliable.

The header names 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)

clicked-on-1-0-0-136

In 1.0.0.138–1.0.0.143

Command 115 on requests, sent by the client, reliable.

For what 1, the header names the sender’s champion. For what 0, it names the champion TipShown’s header named, and a client sends it only while it still knows that 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)

clicked-on-1-0-0-143

In 1.0.0.144–3.1.0.0

Carried on requests, sent by the client, reliable, under these commands:

Builds	Command
1.0.0.144–1.0.0.149	109
1.0.0.150–3.1.0.0	106

The header names 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 (2)

clicked-on-1-0-0-149, clicked-on-1-0-0-154

`QuestUpdated`

What a server sends to add a quest to the quest tracker, complete it or remove it. 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.130–1.0.0.131	144
1.0.0.132–1.0.0.137	145
1.0.0.138	147
1.0.0.139–1.0.0.143	146
1.0.0.144–1.0.0.149	140
1.0.0.150–3.1.0.0	137

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.

Vectors (6)

primary-on-1-0-0-131, primary-on-1-0-0-136, primary-on-1-0-0-138, primary-on-1-0-0-143, primary-on-1-0-0-149, primary-on-1-0-0-154

`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 every range of this book

Carried on requests, sent by the client, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.131	214
1.0.0.132–1.0.0.134	215
1.0.0.135	217
1.0.0.136–1.0.0.137	215
1.0.0.138	217
1.0.0.139–1.0.0.140	216
1.0.0.141–1.0.0.143	218
1.0.0.144–1.0.0.149	205
1.0.0.150–3.1.0.0	202

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.

Vectors (9)

enter-on-1-0-0-131, enter-on-1-0-0-134, enter-on-1-0-0-135, enter-on-1-0-0-136, enter-on-1-0-0-138, enter-on-1-0-0-140, enter-on-1-0-0-143, enter-on-1-0-0-149, enter-on-1-0-0-154

`ObjectiveShown`

What a server sends to show the objective panel with a 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.130–1.0.0.143	59
1.0.0.144–1.0.0.149	56
1.0.0.150–3.1.0.0	53

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 (2)

one-on-1-0-0-143, one-on-1-0-0-149

`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 every range of this book

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.143	14
1.0.0.144–3.1.0.0	13

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)

one-on-1-0-0-143

`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.130–1.0.0.131	170
1.0.0.132–1.0.0.134	171
1.0.0.135	173
1.0.0.136–1.0.0.137	171
1.0.0.138	173
1.0.0.139–1.0.0.143	172
1.0.0.144–1.0.0.149	162
1.0.0.150–3.1.0.0	159

No body.

Vectors (8)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`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.130–1.0.0.138

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.130–1.0.0.131	168
1.0.0.132–1.0.0.134	169
1.0.0.135	171
1.0.0.136–1.0.0.137	169
1.0.0.138	171

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.

Vectors (5)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138

In 1.0.0.139–1.0.0.143

Command 170 on events, sent by the server, reliable.

A client also sizes the panel to the text and shows it. The box sits against the right edge, in the lower part of 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.

Vectors (1)

one-on-1-0-0-143

In 1.0.0.144–3.1.0.0

Carried on events, sent by the server, reliable, under these commands:

Builds	Command
1.0.0.144–1.0.0.149	160
1.0.0.150–3.1.0.0	157

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.

Vectors (2)

one-on-1-0-0-149, one-on-1-0-0-154

`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.130–1.0.0.131	185
1.0.0.132–1.0.0.134	186
1.0.0.135	188
1.0.0.136–1.0.0.137	186
1.0.0.138	188
1.0.0.139–1.0.0.140	187
1.0.0.141–1.0.0.143	189
1.0.0.144–1.0.0.149	177
1.0.0.150–3.1.0.0	174

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 (9)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138, one-on-1-0-0-140, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`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.130–1.0.0.131	175
1.0.0.132–1.0.0.134	176
1.0.0.135	178
1.0.0.136–1.0.0.137	176
1.0.0.138	178
1.0.0.139–1.0.0.143	177
1.0.0.144–1.0.0.149	167
1.0.0.150–3.1.0.0	164

No body.

Vectors (8)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`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

Command 2 on events, sent by the server, reliable.

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.130–1.0.0.131	187
1.0.0.132–1.0.0.134	188
1.0.0.135	190
1.0.0.136–1.0.0.137	188
1.0.0.138	190
1.0.0.139–1.0.0.140	189
1.0.0.141–1.0.0.143	191
1.0.0.144–1.0.0.149	179
1.0.0.150–3.1.0.0	176

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 (9)

one-on-1-0-0-131, one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138, one-on-1-0-0-140, one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154

`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.130–1.0.0.131

Command 213 on requests, sent by the client, reliable.

No body.

Vectors (1)

one-on-1-0-0-131

In 1.0.0.132–1.0.0.138

Carried on requests, sent by the client, reliable, under these commands:

Builds	Command
1.0.0.132–1.0.0.134	214
1.0.0.135	216
1.0.0.136–1.0.0.137	214
1.0.0.138	216

A client also sends it as its player closes a tip in the tutorial.

No body.

Vectors (4)

one-on-1-0-0-134, one-on-1-0-0-135, one-on-1-0-0-136, one-on-1-0-0-138

In 1.0.0.139–1.0.0.140

Command 215 on requests, sent by the client, reliable.

No body.

Vectors (1)

one-on-1-0-0-140

In 1.0.0.141–3.1.0.0

Carried on requests, sent by the client, reliable, under these commands:

Builds	Command
1.0.0.141–1.0.0.143	217
1.0.0.144–1.0.0.149	204
1.0.0.150–3.1.0.0	201

A client also sends it as its player closes a tip in the tutorial.

No body.

Vectors (3)

one-on-1-0-0-143, one-on-1-0-0-149, one-on-1-0-0-154