Custom consume effects
Implement Hooks::consume_effect to handle a consumable's on_consume_effects entry whose type is in your mod's namespace. The hook runs on the server thread for the acting player when the item is consumed.
From Sunrise's modding bookead8a1e
- The event provides the effect kind and its definition payload as a borrowed
Tag. - You can apply effects, play sounds, teleport the player and drop items through the host.
- An unclaimed kind does nothing.
- Consumable and death protection payloads are decoded once for item definitions and stack component patches. The event borrows the retained payload.
- Invalid payloads refuse loading rather than failing during consumption.
To apply an effect without consuming an item, use LivingRef::apply_consume_effect.
Edit this page on GitHub · Spotted something wrong? Open an issue or ask on Discord.



