LuckPerms API (v5.4)

LuckPerms is a permissions plugin for Minecraft servers. It allows server admins to control what features players can use by creating groups and assigning permissions.

Useful Links

• Project Website
• Wiki - API Introduction
• Wiki - API Usage
• Source Code

Maven

The API artifact is deployed to Maven Central with group id: net.luckperms, artifact id: api.

Packages

Package	Description
net.luckperms.api	Main package for the LuckPerms API interface.
net.luckperms.api.actionlog	ActionLog related functionality.
net.luckperms.api.cacheddata	Caches permission checks and meta lookups for Users and Groups.
net.luckperms.api.context	Context functionality, including ContextSets and ContextCalculators.
net.luckperms.api.event	Main events package.
net.luckperms.api.event.cause	Event causes.
net.luckperms.api.event.context	Events relating to Contexts.
net.luckperms.api.event.extension	Events relating to Extensions.
net.luckperms.api.event.group	Events relating to Groups.
net.luckperms.api.event.log	Events relating to the ActionLog.
net.luckperms.api.event.node	Events relating to changes to a User or Groups NodeMap.
net.luckperms.api.event.player	Events relating to a player.
net.luckperms.api.event.player.lookup	Events relating to a player unique id or username lookup.
net.luckperms.api.event.source	Event sources.
net.luckperms.api.event.sync	Events relating to sync/update tasks.
net.luckperms.api.event.track	Events relating to Tracks.
net.luckperms.api.event.track.mutate	Events relating to changes to a Tracks contents.
net.luckperms.api.event.type	Event abstract types.
net.luckperms.api.event.user	Events relating to Users.
net.luckperms.api.event.user.track	Events relating to a Users movement on a Track.
net.luckperms.api.event.util	Event utilities.
net.luckperms.api.extension	Extensions functionality.
net.luckperms.api.messaging	MessagingService functionality.
net.luckperms.api.messenger	Messenger provider API.
net.luckperms.api.messenger.message	Messenger message abstract types.
net.luckperms.api.messenger.message.type	Messenger message actual types.
net.luckperms.api.metastacking	Meta stacking functionality.
net.luckperms.api.model	Main package for PermissionHolders (Users and Groups) and their corresponding data.
net.luckperms.api.model.data	PermissionHolder (User/Group) data.
net.luckperms.api.model.group	Group data model and functionality.
net.luckperms.api.model.user	User data model and functionality.
net.luckperms.api.node	Node functionality.
net.luckperms.api.node.matcher	Node matchers.
net.luckperms.api.node.metadata	Node metadata.
net.luckperms.api.node.metadata.types	Node metadata types.
net.luckperms.api.node.types	Node types.
net.luckperms.api.platform	Platform specific information and utilities.
net.luckperms.api.query	QueryOptions functionality.
net.luckperms.api.query.dataorder	QueryOptions data order and filter customization.
net.luckperms.api.query.meta	QueryOptions meta customization.
net.luckperms.api.track	Track data model and functionality.
net.luckperms.api.util	Miscellaneous utilities and classes that don't fit into any package.