Staff Handler
Provides functionality for a staff, when an item is inserted into it.
Inheritors
Types
A StaffHandler that shows an "item cannot be used in staff" overlay message to the player trying to use it.
Handler of a staff with no item inserted into it.
Default implementation of StaffHandler. Used for staffs with no registered handler.
Properties
Functions
Called by Staff Mod after an item with this staff handler is inserted into staffStack using mutableItemStackInStaff.
Called on the client side by Fabric API, when the NBT of the held item gets updated.
Called on the client side by Neo/Forge, when the NBT of the held item gets updated.
Called on both the client and the server by Architectury API, when an entity attacks a block with a staff.
Called on both the client by Fabric/Neo/Forge API and the server by Fabric/Neo/Forge API, when an entity attacks an entity with a staff.
Called by Staff Mod before an item with this staff handler is removed from staffStack using mutableItemStackInStaff.
Called on both the client and the server by Staff Mod on Fabric and Neo/Forge API on Neo/Forge, when an entity holding a staff tries to swing its hand.
Returns if attacking with the staff should disable the target's shield.
Called on both the client and the server by Minecraft, when an entity finishes using the staff (usage ticks reach getMaxUseTime).
Called on both the client and the server my Minecraft to get the number of ticks the staff can be used for using the current item.
Gets the action that happens when a player uses the staff.
Returns if the staff's user is immune to lightning strikes while using the staff. Called on both the client and the server by Staff Mod.
Called on both the client and the server by Minecraft, when an entity stops using the staff before being used for getMaxUseTime. If that time is reached, finishUsing will be called.
Called on both the client and the server by Minecraft when the player uses the staff.
Called on both the client and the server by Minecraft, when an entity uses the staff on a block. This method may not be called, if the block handles the use event (for example, a chest).
Called on both the client and the server by Minecraft, when an entity uses the staff on an entity. This method may not be called, if the entity handles the use event (for example, a horse). This method will not be called, if the player is in spectator mode.