Units
How a server puts objects on the field and takes them away: champions, minions, neutral monsters, turrets, pets, markers and props. What a unit then does is in Movement, Combat and Spells, and what it is worth in Replication.
Every object is named by a net id, and Objects and identifiers says what removes each kind of object.
Creating
Each kind of object has its own message:
- a champion,
CreateChampion, which, carrying the client’s own client id, also makes that champion the client’s own; a bot’s champion, the sameCreateChampionnaming no client, orSpawnBot; - a minion sent out from a side’s barracks,
SpawnFromBarracks, and a unit like one, such as a ward,SpawnUnit; - a monster of no side,
CreateNeutral; a pet,SpawnPet; - a turret,
CreateTurret(The client’s data says how it names one), and a turret of the server’s choosing,SpawnTurret; - an object that follows a unit,
CreateFollower, and a change to what it follows,FollowerMaster; - an unseen marker,
SpawnMarker, which other messages can name andMarkerMovedmoves; - a prop, a thing that stands on the map and is looked at,
MapProp, and a change to one,MapPropChanged.
Several of these arrive on their own or inside the EnterSight that brings
the unit into view (see Vision): a client takes either.
CharacterPreload has a client load a character’s art ahead of need.
In 4.1–4.19
A client drops a
CreateChampionor aCreateNeutralthat arrives before it sendsCharacterSelected, reconnecting included. A server MUST send them after it receivesCharacterSelected.
Changing and removing
TeamChanged moves a unit to another side, and ChampionRemoved takes a
champion out of the world. A unit’s death is in Combat.
Bots
A server can tell a client what a bot is thinking (BotDebug), weighing
(BotTargets) or doing (BotState). None of them changes what a player sees.
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).
CreateChampion
What a server sends to put a champion on the field. The header carries zero or names the object this is about; a client accepts either.
In 4.1–4.17
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 75 |
| 4.11–4.17 | 76 |
The champion takes the id in champion, not the header’s; a client first removes any object holding that id. For the client’s own seat, name also becomes its own player’s name. A client drops the message while its map’s navigation data is unloaded, as early in a reconnection. It arrives on its own and also inside EnterSight.
| Field | Type | What it is |
|---|---|---|
| champion | u32 | The name the champion answers to, so later messages can name it. |
| clientId | u32 | The client id of the player the champion belongs to, or 4294967295 where it belongs to none, as a bot’s does. A client takes the champion carrying its own client id as its own. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| skillLevel | u8 | It has no effect. |
| side | u8 | Nonzero for side 100, zero for side 200. |
| bot | u8 | Nonzero where a bot plays the seat; its shown name is then the client’s own bot name for asset, and name has no effect. |
| rank | u8 | It has no effect. |
| spawnIndex | u8 | Where the champion first stands and faces. From 0 to 5, its side’s base position plus the offset the map sets for the side’s head count (players and bots) and this index plus one, facing as the map sets for them. A client works out the head count itself, counting SpawnStart’s bots in it. From 6 up, the base position itself, facing along +X. Movement or sight data replaces it. |
| skin | i32 | Which look it wears. |
| name | text, 128 bytes | What the seat holding it is called. Written out in full and padded with zero bytes to the width above. |
| asset | text, 40 bytes | The name the client loads its art and sound under, written and padded as above. |
| stayDown | f32 | How long it stays down, in seconds, where it is already down. |
| downFor | f32 | How long it has already been down, in seconds. |
| how | 1-byte bits | |
| how.down | bit 0 to 2 | 0 alive; 1 dead but acting on (the state a champion that keeps acting after death is in), where stayDown and downFor have no effect; 2 down, having been down for downFor with stayDown left. A client takes 3 to 7 as 0. |
| how.swap | bit 3 | Set where the champion replaces another. Of no effect otherwise. |
| how.unused | bit 4 to 7 | Unused; a server writes zero. |
Vectors (2)
In 4.18–4.20
Command 76 on events, sent by the server, reliable.
It arrives on its own and also inside EnterSight.
| Field | Type | What it is |
|---|---|---|
| champion | u32 | The name the champion answers to, so later messages can name it. |
| clientId | u32 | The client id of the player the champion belongs to, or 4294967295 where it belongs to none, as a bot’s does. A client takes the champion carrying its own client id as its own. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| skillLevel | u8 | What level the champion’s own spells stand at. |
| who | 1-byte bits | |
| who.side | bit 0 | Which of the two sides the champion is on. A server sets it. |
| who.bot | bit 1 | Set where nobody holds it. |
| who.unused | bit 2 to 7 | Unused; a server writes zero. |
| rank | u8 | How well it plays where nobody holds it. |
| spawnIndex | u8 | Which of its side’s starting places the champion begins at, counted from zero. Where a champion first stands travels in EnterSight. A server can send 0 for every champion; where a champion stands is settled by the movement or sight data that follows. |
| skin | i32 | Which look it wears. |
| name | text, 128 bytes | What the seat holding it is called. Written out in full and padded with zero bytes to the width above. |
| asset | text, 40 bytes | The name the client loads its art and sound under, written and padded as above. |
| stayDown | f32 | How long it stays down, in seconds, where it is already down. |
| downFor | f32 | How long it has already been down, in seconds. |
| deathKind | u32 | What sort of death it is already in, where it is already down. |
| how | 1-byte bits | |
| how.swap | bit 0 | Set where the champion replaces another; a client whose champion it is resets every script’s state. |
| how.hidden | bit 1 | Set to fade the champion’s model out at once. |
| how.unused | bit 2 to 7 | Unused; a server writes zero. |
Vectors (2)
SpawnBot
What a server sends to create a champion played by a bot. The header names no object: a server writes zero.
In 4.1–4.19
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 206 |
| 4.11–4.19 | 207 |
A client first deletes any object it holds under the same id.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The id the bot’s champion takes. |
| node | u8 | The network node it belongs to. |
| x | f32 | Where it appears, in world units. |
| y | f32 | Its height, in world units. |
| z | f32 | Where it appears, in world units. |
| rank | u8 | The bot’s rank. |
| sides | 2-byte bits | Its side. |
| sides.side | bit 0 to 8 | Its side: 100, 200 or 300. |
| sides.unused | bit 9 to 15 | Unused; a server writes zero. |
| skin | i32 | Which skin. |
| name | text, 64 bytes | The name shown for it. The text ends at its first zero byte, which falls within the field. |
| character | text, 64 bytes | The champion’s character name, which is also its unique name. |
Vectors (2)
SpawnFromBarracks
What a server sends to put a unit on the field from the place its side sends them out of.
In 4.1–4.17
Command 3 on events, sent by the server, reliable.
It arrives on its own and also inside EnterSight. The header names the unit this is about.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the unit belongs to, in a field of its own rather than as part of the name that follows. |
| barracks | u32 | The place it came out of, by the identifier its name gives as Objects and identifiers works it out. On map 1 that is a spawn point such as __P_Order_Spawn_Barracks__C01, not the inhibitor named Barracks_T1_C1: named by the inhibitor, a client creates nothing. |
| wave | u8 | Which run of units it belongs to. |
| kind | u8 | What sort of unit it is. |
| damageBonus | i16 | What is added to the damage it deals. |
| healthBonus | i16 | What is added to the health it holds. |
| level | u8 | The level it starts at. |
Vectors (1)
In 4.18–4.20
Command 3 on events, sent by the server, reliable.
It arrives on its own and also inside EnterSight. The header names the unit this is about.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the unit belongs to, in a field of its own rather than as part of the name that follows. |
| barracks | u32 | The place it came out of. |
| wave | u8 | Which run of units it belongs to. |
| kind | u8 | What sort of unit it is. |
| damageBonus | u16 | What is added to the damage it deals. |
| healthBonus | u16 | What is added to the health it holds. |
| level | u8 | The level it starts at. |
Vectors (1)
SpawnUnit
What a server sends to put a minion-like unit on the field, such as a ward.
In 4.1–4.16
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 123 |
| 4.11–4.16 | 124 |
A client deletes any object holding the new unit’s id first, and does nothing more where it cannot make the unit. owner is only who gets the gold the unit earns; clone, where nonzero, is copied, state and inventory. The header names the unit that put it there.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the new unit answers to. |
| owner | u32 | The unit that owns it. |
| node | u8 | Which network node the unit belongs to. |
| atX | f32 | Where it stands, along one ground axis, in world units. |
| atY | f32 | Where it stands, in height, in world units. |
| atZ | f32 | Where it stands, along the other ground axis, in world units. |
| skin | i32 | Which look it wears. |
| clone | u32 | The unit it copies, or zero. |
| flags | 2-byte bits | What sort of unit it is. |
| flags.team | bit 0 to 8 | Which side, as a team number. |
| flags.ignoreCollision | bit 9 | Set where it does not block the way. |
| flags.ward | bit 10 | Set where it is a ward. |
| flags.laneMinion | bit 11 | Set where it is a lane minion. |
| flags.bot | bit 12 | Set where it is driven by the client’s own decisions. |
| flags.unused | bit 13 to 15 | Unused; a server writes zero. |
| targetableToTeam | u32 | Which sides can aim at it, as a set of bits. |
| visibilitySize | f32 | How large it counts as for sight, in world units. |
| name | text, 64 bytes | Its name, padded with zero bytes. |
| asset | text, 64 bytes | The name the client loads its art under, padded with zero bytes. |
| level | u16 | The level it starts at. |
Vectors (2)
In 4.17
Command 124 on events, sent by the server, reliable.
A client deletes any object holding the new unit’s id first, and does nothing more where it cannot make the unit. owner is only who gets the gold the unit earns; clone, where nonzero, is copied, state and inventory; onlyVisibleTo, zero or unknown, restricts nothing. The header names the unit that put it there.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the new unit answers to. |
| owner | u32 | The unit that owns it. |
| node | u8 | Which network node the unit belongs to. |
| atX | f32 | Where it stands, along one ground axis, in world units. |
| atY | f32 | Where it stands, in height, in world units. |
| atZ | f32 | Where it stands, along the other ground axis, in world units. |
| skin | i32 | Which look it wears. |
| clone | u32 | The unit it copies, or zero. |
| flags | 2-byte bits | What sort of unit it is. |
| flags.team | bit 0 to 8 | Which side, as a team number. |
| flags.ignoreCollision | bit 9 | Set where it does not block the way. |
| flags.ward | bit 10 | Set where it is a ward. |
| flags.laneMinion | bit 11 | Set where it is a lane minion. |
| flags.bot | bit 12 | Set where it is driven by the client’s own decisions. |
| flags.unused | bit 13 to 15 | Unused; a server writes zero. |
| targetableToTeam | u32 | Which sides can aim at it, as a set of bits. |
| visibilitySize | f32 | How large it counts as for sight, in world units. |
| name | text, 64 bytes | Its name, padded with zero bytes. |
| asset | text, 64 bytes | The name the client loads its art under, padded with zero bytes. |
| level | u16 | The level it starts at. |
| onlyVisibleTo | u32 | The unit that alone can see it, or zero. |
Vectors (1)
In 4.18–4.20
Command 124 on events, sent by the server, reliable.
A client deletes any object holding the new unit’s id first, and does nothing more where it cannot make the unit. owner is only who gets the gold the unit earns; clone, where nonzero, is copied, state and inventory; onlyVisibleTo, zero or unknown, restricts nothing. The header names the unit that put it there.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the new unit answers to. |
| owner | u32 | The unit that owns it. |
| node | u8 | Which network node the unit belongs to. |
| atX | f32 | Where it stands, along one ground axis, in world units. |
| atY | f32 | Where it stands, in height, in world units. |
| atZ | f32 | Where it stands, along the other ground axis, in world units. |
| skin | i32 | Which look it wears. |
| clone | u32 | The unit it copies, or zero. |
| team | u16 | Which side, as a team number. |
| flags | 1-byte bits | What sort of unit it is. |
| flags.ignoreCollision | bit 0 | Set where it does not block the way. |
| flags.ward | bit 1 | Set where it is a ward. |
| flags.laneMinion | bit 2 | Set where it is a lane minion. |
| flags.bot | bit 3 | Set where it is driven by the client’s own decisions. |
| flags.unused | bit 4 to 7 | Unused; a server writes zero. |
| unused | u32 | Unused; a server writes zero. |
| visibilitySize | f32 | How large it counts as for sight, in world units. |
| name | text, 64 bytes | Its name, padded with zero bytes. |
| asset | text, 64 bytes | The name the client loads its art under, padded with zero bytes. |
| level | u16 | The level it starts at. |
| onlyVisibleTo | u32 | The unit that alone can see it, or zero. |
Vectors (1)
CreateNeutral
What a server sends to put a unit that belongs to no side on the field. The header names the unit this is about.
In 4.1
Command 98 on events, sent by the server, reliable.
The monster faces from where it stands toward the facing point, or along +Z where the two are the same. A client drops the message while its map’s navigation data is unloaded. A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| atX | f32 | Where the unit stands, along one ground axis, in world units. |
| atY | f32 | Where the unit stands, in height, in world units. |
| atZ | f32 | Where the unit stands, along the other ground axis, in world units. |
| campAtX | f32 | Where the camp it belongs to sits, along one ground axis, in world units. |
| campAtY | f32 | Where the camp it belongs to sits, in height, in world units. |
| campAtZ | f32 | Where the camp it belongs to sits, along the other ground axis, in world units. |
| facingX | f32 | A point the unit faces toward, along one ground axis, in world units. |
| facingY | f32 | That point, in height. |
| facingZ | f32 | That point, along the other ground axis. |
| name | text, 64 bytes | What this unit is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
| uniqueName | text, 64 bytes | A further name the unit answers to, written and padded as above. |
| campIcon | text, 64 bytes | The name of the icon the minimap shows at the camp, written in full and padded with zero bytes to the width above; empty shows none. A client uses it only where it creates the camp. |
| proximityAnimations | text, 64 bytes | The name of a set of animations the camp plays as units come near, written and padded as above; empty means none. A client uses it only where it creates the camp. |
| side | u32 | The side it belongs to, or zero where it belongs to none. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to the health it holds. |
| roaming | u32 | How the monster wanders. It has no effect. Values: 0 inactive, 1 hostile, 2 fleeing. |
| camp | u32 | Which camp the unit belongs to. A client adds the unit to that camp where a CampMarker has placed it first, and to no camp otherwise. |
| effectSide | u32 | The side that gains what killing it grants. |
| revealEvent | i32 | What makes the unit known to a side that cannot see it. |
| level | i32 | The level it starts at. |
Vectors (1)
In 4.2–4.8
Command 98 on events, sent by the server, reliable.
The monster faces from where it stands toward the facing point, or along +Z where the two are the same. Its spawnAnimation plays only where named and time is left to spawn, and it cannot be targeted while it plays. A client drops the message while its map’s navigation data is unloaded. A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| atX | f32 | Where the unit stands, along one ground axis, in world units. |
| atY | f32 | Where the unit stands, in height, in world units. |
| atZ | f32 | Where the unit stands, along the other ground axis, in world units. |
| campAtX | f32 | Where the camp it belongs to sits, along one ground axis, in world units. |
| campAtY | f32 | Where the camp it belongs to sits, in height, in world units. |
| campAtZ | f32 | Where the camp it belongs to sits, along the other ground axis, in world units. |
| facingX | f32 | A point the unit faces toward, along one ground axis, in world units. |
| facingY | f32 | That point, in height. |
| facingZ | f32 | That point, along the other ground axis. |
| name | text, 64 bytes | What this unit is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
| uniqueName | text, 64 bytes | A further name the unit answers to, written and padded as above. |
| campIcon | text, 64 bytes | The name of the icon the minimap shows at the camp, written in full and padded with zero bytes to the width above; empty shows none. A client uses it only where it creates the camp. |
| spawnAnimation | text, 64 bytes | The name the client loads what it does on arriving under, written and padded as above. |
| side | u32 | The side it belongs to, or zero where it belongs to none. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to the health it holds. |
| roaming | u32 | How the monster wanders. It has no effect. Values: 0 inactive, 1 hostile, 2 fleeing. |
| camp | u32 | Which camp the unit belongs to. A client adds the unit to that camp where a CampMarker has placed it first, and to no camp otherwise. |
| effectSide | u32 | The side that gains what killing it grants. |
| revealEvent | i32 | What makes the unit known to a side that cannot see it. |
| level | i32 | The level it starts at. |
| spawnDuration | f32 | How long its arrival takes, in seconds. |
| spawnElapsed | f32 | How much of its arrival has already passed, in seconds. |
Vectors (1)
In 4.9–4.11
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.9–4.10 | 98 |
| 4.11 | 99 |
The monster faces from where it stands toward the facing point, or along +Z where the two are the same. Its spawnAnimation plays only where named and time is left to spawn, and it cannot be targeted while it plays. A client drops the message while its map’s navigation data is unloaded. A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| atX | f32 | Where the unit stands, along one ground axis, in world units. |
| atY | f32 | Where the unit stands, in height, in world units. |
| atZ | f32 | Where the unit stands, along the other ground axis, in world units. |
| campAtX | f32 | Where the camp it belongs to sits, along one ground axis, in world units. |
| campAtY | f32 | Where the camp it belongs to sits, in height, in world units. |
| campAtZ | f32 | Where the camp it belongs to sits, along the other ground axis, in world units. |
| facingX | f32 | A point the unit faces toward, along one ground axis, in world units. |
| facingY | f32 | That point, in height. |
| facingZ | f32 | That point, along the other ground axis. |
| name | text, 64 bytes | What this unit is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
| uniqueName | text, 64 bytes | A further name the unit answers to, written and padded as above. |
| spawnAnimation | text, 64 bytes | The name the client loads what it does on arriving under, written and padded as above. |
| side | u32 | The side it belongs to, or zero where it belongs to none. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to the health it holds. |
| roaming | u32 | How the monster wanders. It has no effect. Values: 0 inactive, 1 hostile, 2 fleeing. |
| camp | u32 | Which camp the unit belongs to. A client adds the unit to that camp where a CampMarker has placed it first, and to no camp otherwise. |
| effectSide | u32 | The side that gains what killing it grants. |
| revealEvent | i32 | What makes the unit known to a side that cannot see it. |
| level | i32 | The level it starts at. |
| spawnDuration | f32 | How long its arrival takes, in seconds. |
| spawnAt | f32 | When it arrives, as a moment on the match clock, in seconds. |
Vectors (2)
In 4.12–4.17
Command 99 on events, sent by the server, reliable.
The monster faces from where it stands toward the facing point, or along +Z where the two are the same. Its spawnAnimation plays only where named and time is left to spawn, and it cannot be targeted while it plays. A client drops the message while its map’s navigation data is unloaded. A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| atX | f32 | Where the unit stands, along one ground axis, in world units. |
| atY | f32 | Where the unit stands, in height, in world units. |
| atZ | f32 | Where the unit stands, along the other ground axis, in world units. |
| campAtX | f32 | Where the camp it belongs to sits, along one ground axis, in world units. |
| campAtY | f32 | Where the camp it belongs to sits, in height, in world units. |
| campAtZ | f32 | Where the camp it belongs to sits, along the other ground axis, in world units. |
| facingX | f32 | A point the unit faces toward, along one ground axis, in world units. |
| facingY | f32 | That point, in height. |
| facingZ | f32 | That point, along the other ground axis. |
| name | text, 64 bytes | What this unit is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
| uniqueName | text, 64 bytes | A further name the unit answers to, written and padded as above. |
| spawnAnimation | text, 64 bytes | The name the client loads what it does on arriving under, written and padded as above. |
| side | u32 | The side it belongs to, or zero where it belongs to none. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to the health it holds. |
| roaming | u32 | How the monster wanders. It has no effect. Values: 0 inactive, 1 hostile, 2 fleeing. |
| camp | u32 | Which camp the unit belongs to. A client adds the unit to that camp where a CampMarker has placed it first, and to no camp otherwise. |
| effectSide | u32 | The side that gains what killing it grants. |
| revealEvent | i32 | What makes the unit known to a side that cannot see it. |
| level | i32 | The level it starts at. |
| spawnDuration | f32 | How long its arrival takes, in seconds. |
| spawnAt | f32 | When it arrives, as a moment on the match clock, in seconds. |
| behaviour | u8 | It has no effect. |
Vectors (1)
In 4.18–4.20
Command 99 on events, sent by the server, reliable.
A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The name the unit answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| atX | f32 | Where the unit stands, along one ground axis, in world units. |
| atY | f32 | Where the unit stands, in height, in world units. |
| atZ | f32 | Where the unit stands, along the other ground axis, in world units. |
| campAtX | f32 | Where the camp it belongs to sits, along one ground axis, in world units. |
| campAtY | f32 | Where the camp it belongs to sits, in height, in world units. |
| campAtZ | f32 | Where the camp it belongs to sits, along the other ground axis, in world units. |
| facingX | f32 | A point the unit faces toward, along one ground axis, in world units. |
| facingY | f32 | That point, in height. |
| facingZ | f32 | That point, along the other ground axis. |
| name | text, 64 bytes | What this unit is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
| uniqueName | text, 64 bytes | A further name the unit answers to, written and padded as above. |
| spawnAnimation | text, 64 bytes | The name the client loads what it does on arriving under, written and padded as above. |
| side | u32 | The side it belongs to, or zero where it belongs to none. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to the health it holds. |
| roaming | u32 | How it roams, which changes nothing a client shows. Values: 0 still, 1 hostile, 2 fleeing. |
| camp | u32 | Which camp it belongs to. |
| effectSide | u32 | The side that gains what killing it grants. |
| revealEvent | i32 | What makes the unit known to a side that cannot see it. |
| level | i32 | The level it starts at. |
| spawnDuration | f32 | How long its arrival takes, in seconds. |
| spawnAt | f32 | When it arrives, as a moment on the match clock, in seconds. |
Vectors (1)
SpawnPet
What a server sends to put a pet on the field.
In 4.1–4.19
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 54 |
| 4.11–4.19 | 55 |
A client deletes any object holding the header’s id; spawns nothing where it does not know the owner; kills the owner’s earlier pet if it lives; makes the pet, replacing its script with script; gives it the owner’s seat, its gold going to the owner; and registers it under the header’s id and node. spellLevel, duration and effect have no effect. The header names the pet. A server sends it to clients watching a match.
| Field | Type | What it is |
|---|---|---|
| owner | u32 | The unit it belongs to. |
| node | u8 | Which network node it belongs to. |
| atX | f32 | Where it stands, along one ground axis, in world units. |
| atY | f32 | In height, in world units. |
| atZ | f32 | Along the other ground axis, in world units. |
| spellLevel | i32 | The level of the spell that summoned it, plus one. |
| duration | f32 | How long it lasts, in seconds. |
| side | u32 | Which side. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to its health. |
| name | text, 128 bytes | Its name, padded with zero bytes. |
| asset | text, 32 bytes | The name the client loads its art under, padded with zero bytes. |
| skin | i32 | Which look it wears. |
| effect | text, 64 bytes | An effect it carries, padded with zero bytes. |
| clone | u32 | The unit it copies, or zero. |
| flags | 1-byte bits | How it behaves. |
| flags.copyInventory | bit 0 | Set where it copies its owner’s items. |
| flags.clearOwnerTarget | bit 1 | Set where its owner’s target is cleared. |
| flags.minimapIcon | bit 2 | Set where it shows on the minimap. |
| flags.unused | bit 3 to 7 | Unused; a server writes zero. |
| script | text, 32 bytes | The script that drives it, padded with zero bytes. |
Vectors (3)
In 4.20
Command 55 on events, sent by the server, reliable.
A client deletes any object holding the header’s id; spawns nothing where it does not know the owner; kills the owner’s earlier pet if it lives; makes the pet, replacing its script with script; gives it the owner’s seat, its gold going to the owner; and registers it under the header’s id and node. spellLevel, duration and effect have no effect. The header names the pet. A server sends it to clients watching a match.
| Field | Type | What it is |
|---|---|---|
| owner | u32 | The unit it belongs to. |
| node | u8 | Which network node it belongs to. |
| atX | f32 | Where it stands, along one ground axis, in world units. |
| atY | f32 | In height, in world units. |
| atZ | f32 | Along the other ground axis, in world units. |
| spellLevel | i32 | The level of the spell that summoned it, plus one. |
| duration | f32 | How long it lasts, in seconds. |
| side | u32 | Which side. |
| damageBonus | i32 | What is added to the damage it deals. |
| healthBonus | i32 | What is added to its health. |
| name | text, 128 bytes | Its name, padded with zero bytes. |
| asset | text, 32 bytes | The name the client loads its art under, padded with zero bytes. |
| skin | i32 | Which look it wears. |
| effect | text, 64 bytes | An effect it carries, padded with zero bytes. |
| clone | u32 | The unit it copies, or zero. |
| flags | 1-byte bits | How it behaves. |
| flags.copyInventory | bit 0 | Set where it copies its owner’s items. |
| flags.clearOwnerTarget | bit 1 | Set where its owner’s target is cleared. |
| flags.minimapIcon | bit 2 | Set where it shows on the minimap, should it be a clone. |
| flags.startFaded | bit 3 | Set where it starts fully faded out, as though faded to nothing at once; a later fade can bring it back. |
| flags.unused | bit 4 to 7 | Unused; a server writes zero. |
| script | text, 32 bytes | The script that drives it, padded with zero bytes. |
Vectors (1)
CreateTurret
What a server sends to put a turret on the field. The header names the unit this is about.
In 4.1–4.17
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 156 |
| 4.11–4.17 | 157 |
A client matches name exactly against the map’s turrets. With no match it only removes any object holding the id; a matched turret missing or dead is rebuilt before it takes the id. A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| turret | u32 | The name the turret answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| name | text, 64 bytes | What this turret is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| how | 1-byte bits | |
| how.targetable | bit 0 | It has no effect: a turret’s targetability comes by replication. |
| how.unused | bit 1 to 7 | Unused; a server writes zero. |
| targetableBy | u32 | Who can target the turret. A server writes the value replication carries for the turret: 8388608 not its own side, 16777216 not the other side, 25165824 nobody, 33554432 everyone, anything else both sides. A client takes the turret’s targetability from replication alone. |
Vectors (2)
In 4.18–4.20
Command 157 on events, sent by the server, reliable.
A server sends it only inside EnterSight, and the channel and delivery given here are those of the message carrying it.
| Field | Type | What it is |
|---|---|---|
| turret | u32 | The name the turret answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to, in a field of its own. |
| name | text, 64 bytes | What this turret is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| how | 1-byte bits | Unused; a server writes zero. |
| how.targetable | bit 0 | Unused; a server writes zero. |
| how.unknown | bit 1 to 7 | Unused; a server writes zero. |
| targetableBy | u32 | Unused; a server writes zero. |
Vectors (2)
SpawnTurret
What a server sends to create a turret of its own choosing. A client first deletes any object it holds under the same id, and does nothing more where it cannot make the character. The header carries zero.
In 4.12–4.14
Command 291 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The id the turret takes. |
| owner | u32 | The unit credited with the gold for its kills, or zero for none. |
| node | u8 | The network node it belongs to. |
| name | text, 64 bytes | The turret’s object name. The text ends at its first zero byte, which falls within the field. |
| character | text, 64 bytes | Its character, that is, its model. |
| x | f32 | Where it stands, in world units. |
| y | f32 | Its height, in world units. |
| z | f32 | Where it stands, in world units. |
| flags | 2-byte bits | Its side and state. |
| flags.side | bit 0 to 8 | Its side. |
| flags.invulnerable | bit 9 | Set where it takes no damage. |
| flags.unused | bit 10 to 15 | Unused; a server writes zero. |
Vectors (1)
In 4.15
Command 291 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The id the turret takes. |
| owner | u32 | The unit credited with the gold for its kills, or zero for none. |
| node | u8 | The network node it belongs to. |
| name | text, 64 bytes | The turret’s object name. The text ends at its first zero byte, which falls within the field. |
| character | text, 64 bytes | Its character, that is, its model. |
| skin | i32 | Which skin. |
| x | f32 | Where it stands, in world units. |
| y | f32 | Its height, in world units. |
| z | f32 | Where it stands, in world units. |
| flags | 2-byte bits | Its side and state. |
| flags.side | bit 0 to 8 | Its side. |
| flags.invulnerable | bit 9 | Set where it takes no damage. |
| flags.unused | bit 10 to 15 | Unused; a server writes zero. |
Vectors (1)
In 4.16–4.17
Command 291 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The id the turret takes. |
| owner | u32 | The unit credited with the gold for its kills, or zero for none. |
| node | u8 | The network node it belongs to. |
| name | text, 64 bytes | The turret’s object name. The text ends at its first zero byte, which falls within the field. |
| character | text, 64 bytes | Its character, that is, its model. |
| skin | i32 | Which skin. |
| x | f32 | Where it stands, in world units. |
| y | f32 | Its height, in world units. |
| z | f32 | Where it stands, in world units. |
| deathDelay | f32 | Seconds after it dies before its model is changed or taken away. |
| flags | 2-byte bits | Its side and state. |
| flags.side | bit 0 to 8 | Its side. |
| flags.invulnerable | bit 9 | Set where it takes no damage. |
| flags.unused | bit 10 to 15 | Unused; a server writes zero. |
Vectors (1)
In 4.18–4.20
Command 291 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The id the turret takes. |
| owner | u32 | The unit credited with the gold for its kills, or zero for none. |
| node | u8 | The network node it belongs to. |
| name | text, 64 bytes | The turret’s object name. The text ends at its first zero byte, which falls within the field. |
| character | text, 64 bytes | Its character, that is, its model. |
| skin | i32 | Which skin. |
| x | f32 | Where it stands, in world units. |
| y | f32 | Its height, in world units. |
| z | f32 | Where it stands, in world units. |
| deathDelay | f32 | Seconds after it dies before its model is changed or taken away. |
| flags | 1-byte bits | Its side and state. |
| flags.unusedLow | bit 0 | Unused; a server writes zero. |
| flags.invulnerable | bit 1 | Set where it takes no damage. |
| flags.unused | bit 2 to 7 | Unused; a server writes zero. |
| side | u16 | Its side. |
Vectors (1)
CreateFollower
What a server sends to put an object on the field that follows a unit. The header names the unit followed.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 240 |
| 4.11–4.20 | 241 |
| Field | Type | What it is |
|---|---|---|
| follower | u32 | The name the new object answers to. |
| node | u8 | Which network node it belongs to. |
| skin | i32 | Which look it wears. |
| name | text, 64 bytes | Its name, padded with zero bytes. |
| asset | text, 64 bytes | The name the client loads its art under, padded with zero bytes. |
Vectors (4)
FollowerMaster
What a server sends to change which unit a following object follows. The header names the follower.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 241 |
| 4.11–4.20 | 242 |
| Field | Type | What it is |
|---|---|---|
| master | u32 | The unit it now follows; one no unit answers to leaves it following none. |
Vectors (4)
SpawnMarker
What a server sends to create an unseen object at a place, which other messages can then name. A client first deletes any object it holds under the same id. The header carries zero.
In every range of this book
Command 256 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The id the marker takes. |
| node | u8 | The network node it belongs to. |
| x | f32 | Where it stands, in world units. |
| y | f32 | Its height, in world units. |
| z | f32 | Where it stands, in world units. |
Vectors (1)
MarkerMoved
What a server sends to move a marker (SpawnMarker) from one place toward another. The header names the marker. A client sets it at the start at once.
In every range of this book
Command 276 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| fromX | f32 | Where it starts, in world units. |
| fromZ | f32 | Where it starts, in world units. |
| toX | f32 | Where it goes, in world units. |
| toZ | f32 | Where it goes, in world units. |
| speed | f32 | How fast it goes, in world units a second. Below zero it jumps to the goal; zero leaves it at the start. |
| faceGoal | u8 | One to turn it the way it moves, zero not to. |
Vectors (2)
MapProp
What a server sends to place a prop on the map: a thing that stands there and is looked at rather than one that acts. The header carries zero or names the object this is about, and a client accepts either.
In 4.1–4.17
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 207 |
| 4.11–4.17 | 208 |
A client takes the prop’s id from prop, not from the header. A scenery prop is turned by pitch, then yaw, then roll, each about the fixed world axes; none is negated or wrapped. An active prop only turns about the up axis, to face the ground direction its x and z give, and faces +z where both are zero.
| Field | Type | What it is |
|---|---|---|
| prop | u32 | The name the prop answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to. It is a field of its own, not the leading byte of the name beside it. |
| skin | i32 | Which look the prop wears. |
| atX | f32 | Where the prop stands, along one ground axis, in world units. |
| atY | f32 | Where the prop stands, in height, in world units. |
| atZ | f32 | Where the prop stands, along the other ground axis, in world units. |
| rotationX | f32 | For scenery, the pitch in degrees: a turn about the x axis, positive turning +y toward +z. For an active prop, x of the direction it faces. |
| rotationY | f32 | For scenery, the yaw in degrees: a turn about the up axis, positive turning +z toward +x, so yaw 0 faces +z and 90 faces +x. For an active prop, y of its facing, which does not turn it. |
| rotationZ | f32 | For scenery, the roll in degrees: a turn about the z axis, positive turning +x toward +y. For an active prop, z of the direction it faces. |
| offsetX | f32 | What is added to where it stands, along one ground axis, in world units. |
| offsetY | f32 | What is added to where it stands, in height, in world units. |
| offsetZ | f32 | What is added to where it stands, along the other ground axis, in world units. |
| scaleX | f32 | What its drawn size is scaled by, along one ground axis. |
| scaleY | f32 | What its drawn size is scaled by, in height. |
| scaleZ | f32 | What its drawn size is scaled by, along the other ground axis. |
| side | 2-byte bits | The side the prop belongs to. A server sends 300, the neutral side. |
| side.side | bit 0 to 8 | The prop’s side. |
| side.unused | bit 9 to 15 | Unused; a server writes zero. |
| skillLevel | u8 | Unused; a server writes zero. |
| rank | u8 | How far it is advanced. |
| kind | u8 | What sort of prop it is; a client makes nothing for any other value. A client first deletes any object holding the prop’s id, whatever the kind. Values: 0 active, 1 scenery. |
| name | text, 64 bytes | What this prop is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
Vectors (2)
In 4.18–4.20
Command 208 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| prop | u32 | The name the prop answers to, so later messages can name it. |
| node | u8 | Which network node the object belongs to. It is a field of its own, not the leading byte of the name beside it. |
| skin | i32 | Which look the prop wears. |
| atX | f32 | Where the prop stands, along one ground axis, in world units. |
| atY | f32 | Where the prop stands, in height, in world units. |
| atZ | f32 | Where the prop stands, along the other ground axis, in world units. |
| rotationX | f32 | An angle the prop is turned by about a ground axis, in degrees, from zero up to but not reaching 360. |
| rotationY | f32 | An angle the prop is turned by about the upright axis, in degrees, from zero up to but not reaching 360. |
| rotationZ | f32 | An angle the prop is turned by about the other ground axis, in degrees, from zero up to but not reaching 360. |
| offsetX | f32 | What is added to where it stands, along one ground axis, in world units. |
| offsetY | f32 | What is added to where it stands, in height, in world units. |
| offsetZ | f32 | What is added to where it stands, along the other ground axis, in world units. |
| scaleX | f32 | What its drawn size is scaled by, along one ground axis. |
| scaleY | f32 | What its drawn size is scaled by, in height. |
| scaleZ | f32 | What its drawn size is scaled by, along the other ground axis. |
| side | u16 | The side it belongs to, or zero where it belongs to none. |
| rank | u8 | How far it is advanced. |
| skillLevel | u8 | What level the prop’s own doings stand at. |
| kind | u32 | What sort of prop it is. |
| name | text, 64 bytes | What this prop is called, so a client can tell one from another. Written out in full and padded with zero bytes to the width above. |
| asset | text, 64 bytes | The name the client loads its art and sound under, written and padded as above. |
Vectors (2)
MapPropChanged
What a server sends to change something about a prop already on the map. The kind of change is named inside it, and the fields around the kind keep one layout whatever it is. The header names no object: it carries zero.
In 4.1–4.17
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 208 |
| 4.11–4.17 | 209 |
| Field | Type | What it is |
|---|---|---|
| name | text, 64 bytes | A name: an animation’s, a particle’s or a look’s, by the change below. The name ends at its first zero byte; the bytes after it carry no meaning. |
| first | f32 | For animate, when the animation starts, in seconds of match time. |
| second | f32 | For animate, how long the animation runs, in seconds. |
| prop | u32 | The object changed. |
| value | u32 | A value the change uses: for animate, the animation’s flags; for linkEffect, the particle effect value; for look, the look’s number. |
| change | u8 | What changes. A client does nothing for any other value, nor where prop names no prop it holds. Values: 0 animate, 1 linkEffect, 2 look. |
| option | u8 | For animate, nonzero to remove the prop after the animation; for linkEffect, zero. |
| effect | u8 | For linkEffect, which of the prop’s effect values to drive. |
| point | u8 | For linkEffect, which capture point drives it. |
Vectors (2)
In 4.18–4.20
Command 209 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| name | text, 64 bytes | The name the change loads, such as a set of movements the prop plays. Written out in full and padded with zero bytes to the width above. |
| startsAt | f32 | When the change begins, in milliseconds of match time. |
| lasts | f32 | How long the change runs, in seconds. |
| prop | u32 | The prop changed, by the name MapProp gave it. |
| flags | u32 | For kind 1, passed to the movements: 2 holds the last pose where they do not repeat. For kind 3, the look’s number. Not read for kind 2. |
| kind | u32 | What sort of change it is. A client ignores any value but 1, 2 and 3, and a prop it does not know. Values: 1 animate, 2 captureEffect, 3 look. |
| byteA | u8 | For kind 1, not zero to remove the prop once the movements end. For kind 2, the change applies only where it is zero. |
| byteB | u8 | For kind 2, which of the prop’s particle values to drive. Otherwise unused. |
| byteC | u8 | For kind 2, the capture point whose state drives it. Otherwise unused. |
Vectors (2)
CharacterPreload
What a server sends to have a character and a skin of it loaded ahead of need. Nothing shows. The header carries zero.
In 4.6–4.20
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.6–4.10 | 137 |
| 4.11–4.20 | 138 |
| Field | Type | What it is |
|---|---|---|
| skin | i32 | Which skin. |
| character | text, 64 bytes | The character’s name. It ends at its first zero byte. |
Vectors (3)
TeamChanged
What a server sends to move a unit to another side. The header names the unit.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 214 |
| 4.11–4.20 | 215 |
| Field | Type | What it is |
|---|---|---|
| unit | u32 | The unit. |
| side | u32 | Its new side. |
Vectors (4)
ChampionRemoved
What a server sends to take a champion out of the world. It carries nothing of its own. The header names the champion.
In every range of this book
Command 272 on events, sent by the server, reliable.
No body.
Vectors (2)
BotDebug
What a server sends describing what a bot is thinking. It changes nothing a client shows. The header names the unit.
In every range of this book
Command 19 on events, sent by the server, reliable.
| Field | Type | What it is |
|---|---|---|
| name | text, 64 bytes | The bot’s name. |
| strategy | text, 64 bytes | Its strategy. |
| behaviour | text, 64 bytes | Its behaviour. |
| task | text, 64 bytes | Its task. |
| state1 | text, 64 bytes | A line of its state. |
| state2 | text, 64 bytes | A line of its state. |
| state3 | text, 64 bytes | A line of its state. |
Vectors (2)
BotTargets
What a server sends naming the units a bot is weighing. It changes nothing a client shows. The header names the unit.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 104 |
| 4.11–4.20 | 105 |
| Field | Type | What it is |
|---|---|---|
| targets | 5 × u32 | Five units. |
Vectors (3)
BotState
What a server sends naming a bot’s state. It changes nothing a client shows. The header names the unit.
In every range of this book
Carried on events, sent by the server, reliable, under these commands:
| Builds | Command |
|---|---|
| 4.1–4.10 | 169 |
| 4.11–4.20 | 170 |
| Field | Type | What it is |
|---|---|---|
| state | i32 | The state. |