New API

Show API added in: 5.0 5.1 5.2 5.3 5.4 5.5 all

Contents

• Interfaces
• Enum Classes
• Fields
• Methods
• Enum Constants

Interface	Added in	Description
net.luckperms.api.actionlog.filter.ActionFilter	5.5	A predicate filter which matches certain Actions.
net.luckperms.api.actionlog.filter.ActionFilterFactory	5.5	A factory which creates ActionFilters.
net.luckperms.api.cacheddata.Result	5.4	Represents the result of a cached data lookup.
net.luckperms.api.event.context.ContextUpdateEvent	5.2	Called when a subject's current/active contexts are updated.
net.luckperms.api.event.messaging.CustomMessageReceiveEvent	5.5	Called when a custom payload message is received via the MessagingService.
net.luckperms.api.event.player.lookup.UniqueIdDetermineTypeEvent	5.3	Called when the platform needs to determine the type of a player's unique id.
net.luckperms.api.event.player.lookup.UniqueIdLookupEvent	5.3	Called when the platform needs a unique id for a given username.
net.luckperms.api.event.player.lookup.UsernameLookupEvent	5.3	Called when the platform needs a username for a given unique id.
net.luckperms.api.event.player.lookup.UsernameValidityCheckEvent	5.3	Called when the validity of a username is being tested.
net.luckperms.api.event.sync.PostNetworkSyncEvent	5.5	Called after a network synchronisation task has been completed.
net.luckperms.api.event.type.ResultEvent	5.3	Represents an event that has a result.
net.luckperms.api.event.user.UserUnloadEvent	5.3	Called when a user is about to be unloaded from memory.
net.luckperms.api.messenger.message.type.CustomMessage	5.5	Represents a "custom payload" message.
net.luckperms.api.node.matcher.NodeMatcher	5.1	A predicate which matches certain Nodes.
net.luckperms.api.node.matcher.NodeMatcherFactory	5.1	A factory which creates NodeMatchers.
net.luckperms.api.platform.Health	5.5	Represents the "health" status (healthcheck) of a LuckPerms implementation.
net.luckperms.api.platform.PlayerAdapter	5.1	A utility class for adapting platform Player instances to LuckPerms Users.
net.luckperms.api.query.dataorder.DataTypeFilterFunction	5.2	A function that generates a DataTypeFilter predicate for PermissionHolders as required during inheritance.
net.luckperms.api.query.meta.MetaValueSelector	5.1	A function that selects the meta value to be used in queries against a given meta key.
net.luckperms.api.query.QueryOptionsRegistry	5.1	A registry providing useful QueryOptions instances.
net.luckperms.api.util.Page	5.5	Represents a page of entries.

Enum Class	Added in	Description
net.luckperms.api.context.ContextSatisfyMode	5.2	Mode for determining whether a ContextSet satisfies another.
net.luckperms.api.event.sync.SyncType	5.5	Represents the type of synchronisation task.
net.luckperms.api.query.dataorder.DataTypeFilter	5.2	Represents which different DataTypes are used for a query.

Field	Added in	Description
net.luckperms.api.context.DefaultContextKeys.DIMENSION_TYPE_KEY	5.3	The context key used to denote the dimension type of the subjects world.
net.luckperms.api.context.DefaultContextKeys.GAMEMODE_KEY	5.3	The context key used to denote the subjects gamemode.
net.luckperms.api.event.player.lookup.UniqueIdDetermineTypeEvent.TYPE_NPC	5.4	The players UUID most likely belongs to a NPC (non-player character).
net.luckperms.api.event.player.lookup.UniqueIdDetermineTypeEvent.TYPE_UNKNOWN	5.4	Unknown UUID type.

Method	Added in	Description
net.luckperms.api.actionlog.ActionLogger.queryActions(ActionFilter)	5.5	Gets all actions from the action log matching the given filter.
net.luckperms.api.actionlog.ActionLogger.queryActions(ActionFilter, int, int)	5.5	Gets a page of actions from the action log matching the given filter.
net.luckperms.api.cacheddata.CachedDataManager.getMetaData()	5.1	Gets MetaData from the cache, using the most appropriate query options available at the time.
net.luckperms.api.cacheddata.CachedDataManager.getPermissionData()	5.1	Gets PermissionData from the cache, using the most appropriate query options available at the time.
net.luckperms.api.cacheddata.CachedMetaData.getMetaValue(String, Function<String, ? extends T>)	5.3	Gets a value for the given meta key, and runs it through the given transformer.
net.luckperms.api.cacheddata.CachedMetaData.getPrimaryGroup()	5.1	Gets the name of the holders primary group.
net.luckperms.api.cacheddata.CachedMetaData.getWeight()	5.5	Gets the weight.
net.luckperms.api.cacheddata.CachedMetaData.queryMetaValue(String)	5.4	Query a meta value for the given key.
net.luckperms.api.cacheddata.CachedMetaData.queryPrefix()	5.4	Query for a prefix.
net.luckperms.api.cacheddata.CachedMetaData.querySuffix()	5.4	Query for a suffix.
net.luckperms.api.cacheddata.CachedMetaData.queryWeight()	5.5	Query for a weight.
net.luckperms.api.cacheddata.CachedPermissionData.queryPermission(String)	5.4	Performs a permission check for the given permission node.
net.luckperms.api.context.Context.isValidKey(String)	5.1	Tests whether key is valid.
net.luckperms.api.context.Context.isValidValue(String)	5.1	Tests whether value is valid.
net.luckperms.api.context.ContextManager.signalContextUpdate(Object)	5.2	Signal to the ContextManager that a subjects current contexts have changed.
net.luckperms.api.context.ContextSet.containsAny(String, Iterable<String>)	5.2	Returns if the ContextSet contains any of the given context pairings.
net.luckperms.api.context.ContextSet.isSatisfiedBy(ContextSet, ContextSatisfyMode)	5.2	Returns if this ContextSet is "satisfied" by another set, according to the given mode.
net.luckperms.api.event.node.NodeClearEvent.getNodes()	5.3	Gets the nodes that were cleared
net.luckperms.api.event.sync.PreNetworkSyncEvent.getSpecificUserUniqueId()	5.5	Gets the unique id of the specific user that will be synced, if applicable.
net.luckperms.api.event.sync.PreNetworkSyncEvent.getType()	5.5	Gets the sync type.
net.luckperms.api.LuckPerms.getActionFilterFactory()	5.5	Gets the ActionFilterFactory.
net.luckperms.api.LuckPerms.getNodeMatcherFactory()	5.1	Gets the NodeMatcherFactory.
net.luckperms.api.LuckPerms.getPlayerAdapter(Class<T>)	5.1	Gets the PlayerAdapter instance, a utility class for adapting platform Player instances to Users.
net.luckperms.api.LuckPerms.getQueryOptionsRegistry()	5.1	Gets the QueryOptionsRegistry.
net.luckperms.api.LuckPerms.runHealthCheck()	5.5	Executes a health check.
net.luckperms.api.messaging.MessagingService.sendCustomMessage(String, String)	5.5	Uses the messaging service to send a message with a custom payload.
net.luckperms.api.model.group.GroupManager.modifyGroup(String, Consumer<? super Group>)	5.1	Loads (or creates) a group from the plugin's storage provider, applies the given action, then saves the group's data back to storage.
net.luckperms.api.model.group.GroupManager.searchAll(NodeMatcher<? extends T>)	5.1	Searches the normal node maps of all known Groups for Node entries matching the given matcher.
net.luckperms.api.model.PermissionHolder.getInheritedGroups(QueryOptions)	5.1	Gets a collection of the Groups this holder inherits nodes from.
net.luckperms.api.model.PermissionHolder.getNodes(NodeType<T>)	5.1	Gets a flattened view of the holders own Nodes of the given type.
net.luckperms.api.model.PermissionHolder.getQueryOptions()	5.1	Gets the most appropriate query options available at the time for the PermissionHolder.
net.luckperms.api.model.PermissionHolder.resolveInheritedNodes(NodeType<T>, QueryOptions)	5.1	Gets a resolved view of the holders own and inherited Nodes of a given type.
net.luckperms.api.model.user.UserManager.deletePlayerData(UUID)	5.2	Deletes any data about a given player from the uuid caching system.
net.luckperms.api.model.user.UserManager.modifyUser(UUID, Consumer<? super User>)	5.1	Loads a user from the plugin's storage provider, applies the given action, then saves the user's data back to storage.
net.luckperms.api.model.user.UserManager.searchAll(NodeMatcher<? extends T>)	5.1	Searches the normal node maps of all known Users for Node entries matching the given matcher.
net.luckperms.api.node.metadata.types.InheritanceOriginMetadata.getDataType()	5.4	Gets the type of the NodeMap the node was inherited from.
net.luckperms.api.node.metadata.types.InheritanceOriginMetadata.wasInherited(PermissionHolder.Identifier)	5.3	Gets whether the associated node was inherited from another holder.
net.luckperms.api.node.Node.getExpiryDuration()	5.1	Gets the time until this node will expire.
net.luckperms.api.node.NodeBuilder.expiry(TemporalAmount)	5.1	Sets the time when the node should expire.
net.luckperms.api.query.dataorder.DataQueryOrderFunction.always(Comparator<DataType>)	5.2	Creates a DataQueryOrderFunction that always returns the given comparator.
net.luckperms.api.query.QueryOptions.satisfies(ContextSet, ContextSatisfyMode)	5.2	Gets whether this QueryOptions satisfies the given required context.
net.luckperms.api.track.TrackManager.modifyTrack(String, Consumer<? super Track>)	5.5	Loads (or creates) a track from the plugin's storage provider, applies the given action, then saves the track's data back to storage.

Enum Constant	Added in	Description
net.luckperms.api.event.cause.DeletionCause.WEB_EDITOR	5.3	The deletion was caused by the web editor