Compatibility
Minecraft: Java Edition
Platforms
75% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Creators
Details
This is an API mod that adds nothing on its own. Its main goal currently is to simplify the process of creating the BlockBlock mod and its addons.
Features
This mod adds a number of events, as well as a permission system framework that allows developers to prevent players from doing certain actions.
Events
BlockBreakEvent.ATTACK
- Triggered when a player starts mining a block
BlockBreakEvent.BEFORE
- Triggered right before a block is broken
BlockBreakEvent.AFTER
- Triggered after a block is sucessfully broken (cannot be cancelled)
BlockPlaceEvent
- Triggered a player places a block
BlockUseEvent
Triggered when a player (right click) uses a block
EntityItemDropEvent
- Triggered when a killed entity is about to drop its loot
EntityUseEvent
- Triggered when a player (right click) uses an entity
ItemUseEvent
- Triggered when a player uses an item
ObjectCraftedEvent
- Triggered when a player enters a valid recipe in a crafting grid
Permission framework
The permission framework makes it easier to lock a certain action, for a certain item, block, entity or other actions. Locking actions is done on a per-player basis.
The API adds 3 ActionContext
classes you can use:
BlockActionContext
- Used for breaking, placement and block interaction.
ItemActionContext
- Used for item usage and crafting recipes.
EntityActionContext
- Used for interacting with entities and preventing their drops.
These context classes contain all the info you might need to decide what you need to do with an action.
Alternatively, you can pass it along to the Permission
class using Permission.isObjectLocked(context)
. This will return whether an object is locked or not for a certain player.
For a more comprehensive guide on how to use the API, please refer to the wiki (under construction).