All Classes

Class	Description
Action	Represents a logged action.
Action.Builder	Builds an Action instance
Action.Source	Represents the source of an action.
Action.Target	Represents the target of an action.
Action.Target.Type	Represents the type of a Action.Target.
ActionLog	Represents the internal LuckPerms log.
ActionLogger	Represents the object responsible for handling action logging.
ActionLogMessage	Represents an "action log" message.
CachedData	Holds cached lookup data for a given set of query options.
CachedDataManager	Holds cached permission and meta lookup data for a PermissionHolder.
CachedDataManager.Container<T extends CachedData>	Manages a specific type of cached data within a CachedDataManager instance.
CachedMetaData	Holds cached meta lookup data for a specific set of contexts.
CachedPermissionData	Holds cached permission lookup data for a specific set of contexts.
Cancellable	Represents an event that can be cancelled
ChatMetaNode<N extends ChatMetaNode<N,B>,B extends ChatMetaNode.Builder<N,B>>	Represents a chat meta node.
ChatMetaNode.Builder<N extends ChatMetaNode<N,B>,B extends ChatMetaNode.Builder<N,B>>	A ChatMetaNode builder.
ChatMetaType	Represents a type of chat meta
ConfigReloadEvent	Called when the configuration is reloaded
Context	Represents an individual context pair.
ContextCalculator<T>	Calculates the contexts applicable for a contextual subject.
ContextConsumer	Functional interface that accepts context key value pairs.
ContextManager	Manages ContextCalculators, and calculates applicable contexts for a given type.
ContextSatisfyMode	Mode for determining whether a ContextSet satisfies another.
ContextSet	A set of contexts.
ContextSetFactory	A factory for creating ContextSets.
ContextUpdateEvent	Called when a subject's current/active contexts are updated.
CreationCause	The cause of a group/track creation
DataMutateResult	Represents the result of a data mutation call on a LuckPerms object.
DataMutateResult.WithMergedNode	Extension of DataMutateResult for temporary set operations.
DataQueryOrder	Represents the order in which to query different DataTypes.
DataQueryOrderFunction	A function that generates a DataQueryOrder comparator for PermissionHolders as required during inheritance.
DataType	Represents a type of data.
DataTypeFilter	Represents which different DataTypes are used for a query.
DataTypeFilterFunction	A function that generates a DataTypeFilter predicate for PermissionHolders as required during inheritance.
DefaultContextKeys	Some default context keys used by the plugin.
DeletionCause	The cause of a group/track deletion
DemotionResult	Encapsulates the result of Users demotion along a Track.
DemotionResult.Status	The result status
DisplayNameNode	A sub-type of Node used to mark the display name of the node's holder.
DisplayNameNode.Builder	A DisplayNameNode builder.
DuplicateRemovalFunction	Functional interface which removes duplicate entries from a list.
EntitySource	Represents an PlatformEntity which was the Source of something.
EventBus	The LuckPerms event bus.
EventSubscription<T extends LuckPermsEvent>	Represents a subscription to a LuckPermsEvent.
Extension	Represents a simple extension "plugin" for LuckPerms.
ExtensionLoadEvent	Called when an Extension is loaded.
ExtensionManager	Manages extensions.
Flag	The flags which can be set for a query.
Group	An inheritable holder of permission data.
GroupCacheLoadEvent	Called when a groups CachedDataManager is loaded.
GroupCreateEvent	Called when a group is created
GroupDataRecalculateEvent	Called when a groups cached data is refreshed
GroupDeleteEvent	Called when a group is deleted
GroupLoadAllEvent	Called when all groups have been loaded in from storage.
GroupLoadEvent	Called when a group is loaded into memory from the storage.
GroupManager	Represents the object responsible for managing Group instances.
HeldNode<T>	Deprecated. The only usages of this interface are also deprecated.
ImmutableContextSet	An immutable implementation of ContextSet.
ImmutableContextSet.Builder	A builder for ImmutableContextSet.
IncomingMessageConsumer	Encapsulates the LuckPerms system which accepts incoming Messages from implementations of Messenger.
InheritanceNode	A sub-type of Node used to mark that the holder of the node should inherit from another group.
InheritanceNode.Builder	A InheritanceNode builder.
InheritanceOriginMetadata	Node metadata indicating where a node was inherited from.
LogBroadcastEvent	Called when a log entry is about to be sent to notifiable players on the platform
LogBroadcastEvent.Origin	Represents where a log entry is from
LogNetworkPublishEvent	Called when a log is about to be published to the network via the MessagingService
LogNotifyEvent	Called when a log entry is about to be sent to specific notifiable object on the platform.
LogNotifyEvent.Origin	Represents where a log entry is from
LogPublishEvent	Called when a log is about to be published to the storage file/table
LogReceiveEvent	Called when a log entry is received via the MessagingService
LuckPerms	The LuckPerms API.
LuckPermsEvent	A superinterface for all LuckPerms events.
LuckPermsProvider	Provides static access to the LuckPerms API.
Message	Represents a message sent received via a Messenger.
MessagingService	A means to push changes to other servers using the platforms networking
Messenger	Represents an object which dispatches OutgoingMessages.
MessengerProvider	Represents a provider for Messenger instances.
MetaNode	A sub-type of Node used to store meta assignments.
MetaNode.Builder	A MetaNode builder.
MetaStackDefinition	Represents a meta stack model, consisting of a chain of elements, separated by spacers.
MetaStackElement	Represents an element within a MetaStackDefinition.
MetaStackFactory	Factory to create meta stack elements and definitions.
MetaValueSelector	A function that selects the meta value to be used in queries against a given meta key.
MutableContextSet	A mutable implementation of ContextSet.
Node	Represents a LuckPerms "node".
NodeAddEvent	Called when a node is added to a holder
NodeBuilder<N extends ScopedNode<N,B>,B extends NodeBuilder<N,B>>	Builder for Nodes.
NodeBuilderRegistry	A registry of methods for obtaining NodeBuilders for the various node types.
NodeClearEvent	Called when a holder has their nodes cleared
NodeEqualityPredicate	An equality test for determining if two nodes are to be considered equal.
NodeMap	Encapsulates a store of data (Nodes) within a PermissionHolder.
NodeMatcher<T extends Node>	A predicate which matches certain Nodes.
NodeMatcherFactory	A factory which creates NodeMatchers.
NodeMetadataKey<T>	Represents a key for a specific type of node metadata.
NodeMutateEvent	Called when a node is added to/removed from a user/group
NodeRemoveEvent	Called when a node is removed from a holder
NodeType<T extends Node>	Represents a type of Node.
OptionKey<T>	Represents a key for a custom option defined in QueryOptions.
OutgoingMessage	Represents an outgoing Message.
Param	Represents the position of a parameter within an event.
PermissionHolder	Generic superinterface for an object which holds permissions.
PermissionHolder.Identifier	Represents a way to identify distinct PermissionHolders.
PermissionNode	A sub-type of Node representing basic permissions.
PermissionNode.Builder	A PermissionNode builder.
Platform	Provides information about the platform LuckPerms is running on.
Platform.Type	Represents a type of platform which LuckPerms can run on.
PlatformEntity	Represents an entity on the server.
PlatformEntity.Type	The different types of PlatformEntity
PlayerAdapter<T>	A utility class for adapting platform Player instances to LuckPerms Users.
PlayerDataSaveEvent	Called when player data is saved to the storage.
PlayerLoginProcessEvent	Called when LuckPerms has finished processing a Player's initial connection.
PlayerSaveResult	Encapsulates the result of an operation to save uuid data about a player.
PlayerSaveResult.Outcome	The various states the result can take
PluginMetadata	Provides information about the LuckPerms plugin.
PostSyncEvent	Called when an sync task has been completed
PrefixNode	A sub-type of Node used to store prefix assignments.
PrefixNode.Builder	A PrefixNode builder.
PreNetworkSyncEvent	Called before a received network sync task runs
PreSyncEvent	Called before a sync task runs
PromotionResult	Encapsulates the result of Users promotion along a Track.
PromotionResult.Status	The result status
QueryMode	Represents the type of query associated with a given QueryOptions.
QueryOptions	Represents the parameters for a lookup query.
QueryOptions.Builder	Builder for QueryOptions.
QueryOptionsRegistry	A registry providing useful QueryOptions instances.
RegexPermissionNode	A sub-type of Node used to store regex permissions.
RegexPermissionNode.Builder	A RegexPermissionNode builder.
Result	Represents a generic result, which can either be successful or fail.
ResultEvent<T>	Represents an event that has a result.
ScopedNode<N extends ScopedNode<N,B>,B extends NodeBuilder<N,B>>	A Node, with its own type and the type of its associated builder defined as a type parameter.
Source	Represents the source of an event.
Source.Type	Represents a type of source
Sourced	Represents an event with a Source.
StaticContextCalculator	Extension of ContextCalculator which provides the same context regardless of the subject.
SuffixNode	A sub-type of Node used to store suffix assignments.
SuffixNode.Builder	A SuffixNode builder.
TemporaryNodeMergeStrategy	Controls how the implementation should behave when new temporary nodes are set that would otherwise conflict with existing entries.
Track	An ordered chain of Groups.
TrackAction	Represents the type of action performed in a UserTrackEvent
TrackAddGroupEvent	Called when a group is added to a track
TrackClearEvent	Called when a track is cleared
TrackCreateEvent	Called when a track is created
TrackDeleteEvent	Called when a track is deleted
TrackLoadAllEvent	Called when all tracks have been loaded in from storage.
TrackLoadEvent	Called when a track is loaded into memory from the storage.
TrackManager	Represents the object responsible for managing Track instances.
TrackMutateEvent	Called when a track is changed
TrackRemoveGroupEvent	Called when a group is removed from a track
Tristate	Represents three different states of a setting.
UniqueIdDetermineTypeEvent	Called when the platform needs to determine the type of a player's unique id.
UniqueIdLookupEvent	Called when the platform needs a unique id for a given username.
UpdateMessage	Represents an "update" message.
User	A player which holds permission data.
UserCacheLoadEvent	Called when a users CachedDataManager is loaded.
UserDataRecalculateEvent	Called when a users cached data is refreshed
UserDemoteEvent	Called when a user is demoted down a track.
UserFirstLoginEvent	Called when the user logs into the network for the first time.
UserLoadEvent	Called when a user is loaded into memory from the storage.
UserManager	Represents the object responsible for managing User instances.
UsernameLookupEvent	Called when the platform needs a username for a given unique id.
UsernameValidityCheckEvent	Called when the validity of a username is being tested.
UserPromoteEvent	Called when a user is promoted up a track.
UserTrackEvent	Called when a user interacts with a track through a promotion or demotion
UserUnloadEvent	Called when a user is about to be unloaded from memory.
UserUpdateMessage	Represents an "user update" message.
WeightNode	A sub-type of Node used to mark the weight of the node's holder.
WeightNode.Builder	A WeightNode builder.