Hook points
Hook point reference
Every hook point has a name. Subscribe to one point by its exact name, to a whole family with
<family>.*, or to every point with *. A game event's point has the event's own name
(block_break); the rest are <family>.<...>.
The coverage table gives how many of each kind there are and how they are counted.
| Family | Pattern | Input | Output | Page |
|---|---|---|---|---|
| Commands | command.<root> | {player, name, rest} | bool succeeded | commands |
| Packets | packet.<state>.<direction>.<name> | {player, id, body} | clientbound: [[id, body], ...]; serverbound: {handled, reply} | packets |
| Game events | the event's own name | per event | per event | game events |
| Subsystems | worldgen.*, structure.*, move.*, block.*, loot.*, spawn.*, ai.*, redstone.*, fluid.*, portal.*, permission.* | per point | per point | subsystems |
The generated index lists every hook point the server has. It is derived from the
code by the same rules as tools/api_check.py.
From docs/api/reference/hooks/README.md in the RustMC repository at bbd81209ad.