Skip navigation links
A B C D E F G H I K L M N O P R S T U V W 

A

ActionLogger - Interface in me.lucko.luckperms.api
Represents the object responsible for handling action logging.
add(String, String) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Adds a context to the set.
add(Map.Entry<String, String>) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Adds a context to the set.
add(String, String) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Adds a context to this set.
add(Map.Entry<String, String>) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Adds a context to this set.
addAll(Iterable<? extends Map.Entry<String, String>>) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Adds the contexts contained in the given Iterable to the set.
addAll(Map<String, String>) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Adds the contexts contained in the given Map to the set.
addAll(Multimap<String, String>) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Adds the contexts contained in the given Multimap to the set.
addAll(ContextSet) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Adds of of the contexts in another ContextSet to the set.
addAll(Iterable<? extends Map.Entry<String, String>>) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Adds the contexts contained in the given Iterable to this set.
addAll(Map<String, String>) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Adds the contexts contained in the given Map to this set.
addAll(Multimap<String, String>) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Adds the contexts contained in the given Multimap to this set.
addAll(ContextSet) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Adds of of the contexts in another ContextSet to this set.
allowAll() - Static method in class me.lucko.luckperms.api.Contexts
Gets the FullySatisfiedContexts instance.
almostEquals(Node) - Method in interface me.lucko.luckperms.api.Node
appendGroup(Group) - Method in interface me.lucko.luckperms.api.Track
Appends a group to the end of this track
appliesGlobally() - Method in interface me.lucko.luckperms.api.Node
Gets if this node applies globally, and therefore has no specific context.
areEqual(Node, Node) - Method in interface me.lucko.luckperms.api.NodeEqualityPredicate
Returns if the two nodes are equal
areEqual(Node, Node) - Method in enum me.lucko.luckperms.api.StandardNodeEquality
 
asBoolean() - Method in interface me.lucko.luckperms.api.MutateResult
Gets a boolean representation of the result.
asBoolean() - Method in enum me.lucko.luckperms.api.Tristate
Returns the value of the Tristate as a boolean.
asEncodedString() - Method in interface me.lucko.luckperms.api.messenger.message.OutgoingMessage
Gets an encoded string form of this message.
asNode() - Method in interface me.lucko.luckperms.api.HeldPermission
Converts this permission into a Node
auditTemporaryPermissions() - Method in interface me.lucko.luckperms.api.PermissionHolder
Removes any temporary permissions that have expired.

B

backing() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
backing() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
broadcastAction(LogEntry) - Method in interface me.lucko.luckperms.api.ActionLogger
Submits a log entry to the plugins log broadcasting handler.
build() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet.Builder
Creates a ImmutableContextSet from the values previously added to the builder.
build() - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Creates a LogEntry instance from the builder.
build() - Method in interface me.lucko.luckperms.api.Node.Builder
Creates a Node instance from the builder.
builder() - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
buildNode(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Returns a permission builder instance

C

CachedData - Interface in me.lucko.luckperms.api.caching
Holds cached permission and meta lookup data for a PermissionHolder.
CachedDataContainer - Interface in me.lucko.luckperms.api.caching
Holds cached lookup data in a specific set of contexts.
calculateMeta(MetaContexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Calculates meta data, bypassing the cache.
calculateMeta(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Calculates meta data, bypassing the cache.
calculatePermissions(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Calculates permission data, bypassing the cache.
Cancellable - Interface in me.lucko.luckperms.api.event
Represents an event that can be cancelled
ChatMetaType - Enum in me.lucko.luckperms.api
Represents a type of chat meta
cleanupUser(User) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Unload a user from the internal storage, if they're not currently online.
cleanupUser(User) - Method in interface me.lucko.luckperms.api.manager.UserManager
Unload a user from the internal storage, if they're not currently online.
clear() - Method in class me.lucko.luckperms.api.context.MutableContextSet
Removes all contexts from the set.
clearExpiry() - Method in interface me.lucko.luckperms.api.Node.Builder
Marks that the node being built should never expire.
clearGroups() - Method in interface me.lucko.luckperms.api.Track
Clear all of the groups from this track
clearMatching(Predicate<Node>) - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears any nodes from the holder which pass the predicate.
clearMatchingTransient(Predicate<Node>) - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears any transient nodes from the holder which pass the predicate.
clearMeta() - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all meta held by the permission holder.
clearMeta(ContextSet) - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all meta held by the permission holder in a specific context.
clearNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all nodes held by the permission holder.
clearNodes(ContextSet) - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all nodes held by the permission holder in a specific context.
clearParents() - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all parent groups.
clearParents(ContextSet) - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all parent groups in a specific context.
clearTransientNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
Clears all transient nodes the permission holder has.
close() - Method in interface me.lucko.luckperms.api.event.EventHandler
 
close() - Method in interface me.lucko.luckperms.api.messenger.Messenger
Performs the necessary action to gracefully shutdown the messenger.
ConfigReloadEvent - Interface in me.lucko.luckperms.api.event.sync
Called when the configuration is reloaded
consumeIncomingMessage(Message) - Method in interface me.lucko.luckperms.api.messenger.IncomingMessageConsumer
Consumes a message instance.
consumeIncomingMessageAsString(String) - Method in interface me.lucko.luckperms.api.messenger.IncomingMessageConsumer
Consumes a message in an encoded string format.
containsGroup(Group) - Method in interface me.lucko.luckperms.api.Track
Checks if a group features on this track
containsGroup(String) - Method in interface me.lucko.luckperms.api.Track
Checks if a group features on this track
containsKey(String) - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns if the ContextSet contains at least one value for the given key.
ContextCalculator<T> - Interface in me.lucko.luckperms.api.context
Calculates whether contexts are applicable to a subject.
ContextManager - Interface in me.lucko.luckperms.api.context
Manages ContextCalculators, and calculates applicable contexts for a given type.
Contexts - Class in me.lucko.luckperms.api
Encapsulates the contexts and settings for a permission or meta lookup.
Contexts(ContextSet, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class me.lucko.luckperms.api.Contexts
Contexts(ImmutableContextSet, ImmutableSet<LookupSetting>) - Constructor for class me.lucko.luckperms.api.Contexts
 
ContextSet - Interface in me.lucko.luckperms.api.context
A set of contexts.
copyFrom(Node) - Method in interface me.lucko.luckperms.api.Node.Builder
Copies the attributes from the given node and applies them to this builder.
copyTo(SetMultimap<String, String>) - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
copyTo(SetMultimap<String, String>) - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
create() - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a new empty MutableContextSet.
createAndLoadGroup(String) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Creates a new group in the plugin's storage provider and then loads it into memory.
createAndLoadGroup(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
createAndLoadTrack(String) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Creates a new track in the plugin's storage provider and then loads it into memory.
createAndLoadTrack(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
createDefinition(List<MetaStackElement>, String, String, String) - Method in interface me.lucko.luckperms.api.metastacking.MetaStackFactory
Creates a new MetaStackDefinition with the given properties.
CreationCause - Enum in me.lucko.luckperms.api.event.cause
The cause of a group/track creation

D

DataMutateResult - Enum in me.lucko.luckperms.api
Represents the result of a data mutation call on a LuckPerms object.
deleteGroup(Group) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Permanently deletes a group from the plugin's storage provider.
deleteGroup(Group) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
deleteTrack(Track) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Permanently deletes a track from the plugin's storage provider.
deleteTrack(Track) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
DeletionCause - Enum in me.lucko.luckperms.api.event.cause
The cause of a group/track deletion
demote(User, ContextSet) - Method in interface me.lucko.luckperms.api.Track
Demotes the given user along this track.
DemotionResult - Interface in me.lucko.luckperms.api
Encapsulates the result of Users demotion along a Track.
DemotionResult.Status - Enum in me.lucko.luckperms.api
The result status
DisplayNameType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to mark the display name of the node's holder.

E

empty() - Static method in interface me.lucko.luckperms.api.context.ContextSet
Returns an empty ImmutableContextSet.
empty() - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Returns an empty ImmutableContextSet.
Entity - Interface in me.lucko.luckperms.api
Represents an entity on the server.
Entity.Type - Enum in me.lucko.luckperms.api
The different types of Entity
EntitySource - Interface in me.lucko.luckperms.api.event.source
Represents an Entity which was the Source of something.
equals(Object) - Method in class me.lucko.luckperms.api.caching.MetaContexts
 
equals(Object) - Method in class me.lucko.luckperms.api.Contexts
 
equals(Object) - Method in class me.lucko.luckperms.api.FullySatisfiedContexts
 
equals(Object) - Method in interface me.lucko.luckperms.api.Node
Gets if this Node is equal to another node.
equals(Node, NodeEqualityPredicate) - Method in interface me.lucko.luckperms.api.Node
Gets if this Node is equal to another node as defined by the given NodeEqualityPredicate.
equalsIgnoringValue(Node) - Method in interface me.lucko.luckperms.api.Node
equalsIgnoringValueOrTemp(Node) - Method in interface me.lucko.luckperms.api.Node
EventBus - Interface in me.lucko.luckperms.api.event
The LuckPerms event bus.
EventHandler<T extends LuckPermsEvent> - Interface in me.lucko.luckperms.api.event
Represents a subscription to a LuckPermsEvent.
exportNodes(Contexts, boolean) - Method in interface me.lucko.luckperms.api.PermissionHolder
Converts the output of PermissionHolder.getAllNodesFiltered(Contexts) into string and boolean form, and expands shorthand permissions.

F

formContexts(Object, ImmutableContextSet) - Method in interface me.lucko.luckperms.api.context.ContextManager
Forms a Contexts instance from an ImmutableContextSet.
formContexts(ImmutableContextSet) - Method in interface me.lucko.luckperms.api.context.ContextManager
Forms a Contexts instance from an ImmutableContextSet.
fromBoolean(boolean) - Static method in enum me.lucko.luckperms.api.Tristate
Returns a Tristate from a boolean
fromEntries(Iterable<? extends Map.Entry<String, String>>) - Static method in interface me.lucko.luckperms.api.context.ContextSet
Creates an ImmutableContextSet from an existing Iterable of Map.Entrys.
fromEntries(Iterable<? extends Map.Entry<String, String>>) - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Creates an ImmutableContextSet from an existing Iterable of Map.Entrys.
fromEntries(Iterable<? extends Map.Entry<String, String>>) - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a MutableContextSet from an existing Iterable of Map.Entrys.
fromMap(Map<String, String>) - Static method in interface me.lucko.luckperms.api.context.ContextSet
Creates an ImmutableContextSet from an existing Map.
fromMap(Map<String, String>) - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Creates an ImmutableContextSet from an existing Map.
fromMap(Map<String, String>) - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a MutableContextSet from an existing Map.
fromMultimap(Multimap<String, String>) - Static method in interface me.lucko.luckperms.api.context.ContextSet
Creates an ImmutableContextSet from an existing Multimap.
fromMultimap(Multimap<String, String>) - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Creates an ImmutableContextSet from an existing Multimap.
fromMultimap(Multimap<String, String>) - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a MutableContextSet from an existing Multimap.
fromNullableBoolean(Boolean) - Static method in enum me.lucko.luckperms.api.Tristate
Returns a Tristate from a nullable boolean.
fromSet(ContextSet) - Static method in interface me.lucko.luckperms.api.context.ContextSet
Creates an new ImmutableContextSet from an existing Set.
fromSet(ContextSet) - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Creates an new ImmutableContextSet from an existing Set.
fromSet(ContextSet) - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a new MutableContextSet from an existing Set.
fromString(String) - Method in interface me.lucko.luckperms.api.metastacking.MetaStackFactory
Parses a standard MetaStackElement from string, using the pre-defined elements in the plugin.
fromStrings(List<String>) - Method in interface me.lucko.luckperms.api.metastacking.MetaStackFactory
Parses a list of MetaStackElements from string, using the pre-defined elements in the plugin.
FullySatisfiedContexts - Class in me.lucko.luckperms.api
A special instance of Contexts, which when passed to:

G

GENERIC_FAILURE - Static variable in interface me.lucko.luckperms.api.MutateResult
Instance of MutateResult which always reports failure.
GENERIC_SUCCESS - Static variable in interface me.lucko.luckperms.api.MutateResult
Instance of MutateResult which always reports success.
getActed() - Method in interface me.lucko.luckperms.api.LogEntry
Gets the uuid of the object which was acted upon.
getActedName() - Method in interface me.lucko.luckperms.api.LogEntry
Gets the name describing the object which was acted upon
getAction() - Method in interface me.lucko.luckperms.api.event.user.track.UserDemoteEvent
 
getAction() - Method in interface me.lucko.luckperms.api.event.user.track.UserPromoteEvent
 
getAction() - Method in interface me.lucko.luckperms.api.event.user.track.UserTrackEvent
Gets the action performed
getAction() - Method in interface me.lucko.luckperms.api.LogEntry
Returns a string describing the action which took place.
getActionLogger() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the ActionLogger.
getActor() - Method in interface me.lucko.luckperms.api.LogEntry
Gets the id of the object which performed the action.
getActorName() - Method in interface me.lucko.luckperms.api.LogEntry
Gets the name describing the actor.
getAllNodes(Contexts) - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets a mutable sorted set of the nodes that this object has and inherits, filtered by context
getAllNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets a mutable sorted set of the nodes that this object has and inherits.
getAllNodesFiltered(Contexts) - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets a mutable set of the nodes that this object has and inherits, filtered by context.
getAnyValue(String) - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns any value from this ContextSet matching the key, if present.
getApi() - Method in interface me.lucko.luckperms.api.event.LuckPermsEvent
Get the API instance this event was dispatched from
getApi() - Static method in class me.lucko.luckperms.LuckPerms
Gets an instance of the LuckPermsApi, throwing IllegalStateException if an instance is not yet loaded.
getApiSafe() - Static method in class me.lucko.luckperms.LuckPerms
Gets an instance of LuckPermsApi, if it is loaded.
getApiVersion() - Method in interface me.lucko.luckperms.api.platform.PlatformInfo
Gets the API version
getApplicableContext(Object) - Method in interface me.lucko.luckperms.api.context.ContextManager
Queries the ContextManager for current context values for the subject.
getApplicableContexts(Object) - Method in interface me.lucko.luckperms.api.context.ContextManager
Queries the ContextManager for current context values for the subject.
getApplyGlobalGroups() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets if the platform is applying global groups
getApplyGlobalWorldGroups() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets if the platform is applying global world groups
getAsEntry() - Method in interface me.lucko.luckperms.api.nodetype.types.PrefixType
Gets a representation of this instance as a Map.Entry.
getAsEntry() - Method in interface me.lucko.luckperms.api.nodetype.types.SuffixType
Gets a representation of this instance as a Map.Entry.
getAsyncExecutor() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
as plugins should create their own executors
getCachedData() - Method in interface me.lucko.luckperms.api.Group
Gets the groups's GroupData cache.
getCachedData() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets the holders CachedData cache.
getCachedData() - Method in interface me.lucko.luckperms.api.User
Gets the user's UserData cache.
getCallCount() - Method in interface me.lucko.luckperms.api.event.EventHandler
Gets the number of times this handler has been called
getCancellationState() - Method in interface me.lucko.luckperms.api.event.Cancellable
Gets an AtomicBoolean holding the cancellation state of the event
getCause() - Method in interface me.lucko.luckperms.api.event.group.GroupCreateEvent
Gets the cause of the creation
getCause() - Method in interface me.lucko.luckperms.api.event.group.GroupDeleteEvent
Gets the cause of the deletion
getCause() - Method in interface me.lucko.luckperms.api.event.track.TrackCreateEvent
Gets the cause of the creation
getCause() - Method in interface me.lucko.luckperms.api.event.track.TrackDeleteEvent
Gets the cause of the deletion
getCode() - Method in enum me.lucko.luckperms.api.LogEntry.Type
 
getConfiguration() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a representation of the plugins configuration
getConsumer() - Method in interface me.lucko.luckperms.api.event.EventHandler
Gets the event consumer responsible for handling the event
getContent() - Method in interface me.lucko.luckperms.api.Log
Gets the LogEntrys that make up this log.
getContent(UUID) - Method in interface me.lucko.luckperms.api.Log
Gets the entries in the log performed by the given actor.
getContextForPlayer(Object) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets set of contexts applicable to a player using the platforms ContextCalculators.
getContextForUser(User) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a calculated context instance for the user using the rules of the platform.
getContextManager() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the ContextManager.
getContexts() - Method in interface me.lucko.luckperms.api.caching.CachedDataContainer
Gets the contexts this container is holding data for.
getContexts() - Method in class me.lucko.luckperms.api.caching.MetaContexts
 
getContexts() - Method in class me.lucko.luckperms.api.Contexts
Gets the ContextSet which represent these Contexts.
getContexts() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the extra context for the permission.
getContexts() - Method in interface me.lucko.luckperms.api.Node
Gets the extra contexts required for this node to apply.
getContextsForPlayer(Object) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a Contexts instance for the player using the platforms ContextCalculators.
getData() - Method in interface me.lucko.luckperms.api.event.group.GroupDataRecalculateEvent
Gets the data that was recalculated
getData() - Method in interface me.lucko.luckperms.api.event.user.UserDataRecalculateEvent
Gets the data that was recalculated
getDataAfter() - Method in interface me.lucko.luckperms.api.event.node.NodeMutateEvent
Gets an immutable copy of the holders data after the change
getDataAfter() - Method in interface me.lucko.luckperms.api.event.track.mutate.TrackMutateEvent
Gets an immutable copy of the tracks data after the change
getDataBefore() - Method in interface me.lucko.luckperms.api.event.node.NodeMutateEvent
Gets an immutable copy of the holders data before the change
getDataBefore() - Method in interface me.lucko.luckperms.api.event.track.mutate.TrackMutateEvent
Gets an immutable copy of the tracks data before the change
getDisplayName() - Method in interface me.lucko.luckperms.api.Group
Gets the groups "display name", if it has one that differs from it's actual name.
getDisplayName(ContextSet) - Method in interface me.lucko.luckperms.api.Group
Gets the groups "display name", if it has one that differs from it's actual name.
getDisplayName() - Method in interface me.lucko.luckperms.api.nodetype.types.DisplayNameType
Gets the display name.
getElements() - Method in interface me.lucko.luckperms.api.metastacking.MetaStackDefinition
Gets an immutable list of the elements in this stack definition
getEndSpacer() - Method in interface me.lucko.luckperms.api.metastacking.MetaStackDefinition
Gets the spacer added after any stack elements
getEnduringPermissions() - Method in interface me.lucko.luckperms.api.PermissionHolder
Similar to PermissionHolder.getPermissions(), except only including permissions from the enduring node map.
getEntity() - Method in interface me.lucko.luckperms.api.event.source.EntitySource
Gets the entity.
getEntry(Node) - Method in enum me.lucko.luckperms.api.ChatMetaType
Maps the corresponding entry from the given node
getEntry() - Method in interface me.lucko.luckperms.api.event.log.LogBroadcastEvent
Gets the log entry to be broadcasted
getEntry() - Method in interface me.lucko.luckperms.api.event.log.LogNetworkPublishEvent
Gets the log entry to be published
getEntry() - Method in interface me.lucko.luckperms.api.event.log.LogNotifyEvent
Gets the log entry to be sent
getEntry() - Method in interface me.lucko.luckperms.api.event.log.LogPublishEvent
Gets the log entry to be published
getEntry() - Method in interface me.lucko.luckperms.api.event.log.LogReceiveEvent
Gets the log entry being received
getEventBus() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the EventBus, used for subscribing to internal LuckPerms events.
getEventClass() - Method in interface me.lucko.luckperms.api.event.EventHandler
Gets the class this handler is listening to
getExistingData() - Method in interface me.lucko.luckperms.api.event.group.GroupDeleteEvent
Gets an immutable copy of the groups existing data
getExistingData() - Method in interface me.lucko.luckperms.api.event.track.TrackDeleteEvent
Gets an immutable copy of the tracks existing data
getExpiry() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the time in unix time when the permission will expire
getExpiry() - Method in interface me.lucko.luckperms.api.Node
Gets the date when this node will expire.
getExpiryUnixTime() - Method in interface me.lucko.luckperms.api.Node
Gets the unix timestamp (in seconds) when this node will expire.
getExternalUUID(UUID) - Method in interface me.lucko.luckperms.api.UuidCache
Deprecated.
getFriendlyName() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets a friendly name for this holder, to be displayed in command output, etc.
getFriendlyName() - Method in enum me.lucko.luckperms.api.platform.PlatformType
Gets a readable name for the platform type.
getFullContexts() - Method in interface me.lucko.luckperms.api.Node
The same as Node.getContexts(), but also includes context pairs for "server" and "world" keys if present.
getGroup() - Method in interface me.lucko.luckperms.api.event.group.GroupCacheLoadEvent
Gets the group whose data was loaded
getGroup() - Method in interface me.lucko.luckperms.api.event.group.GroupCreateEvent
Gets the new group
getGroup() - Method in interface me.lucko.luckperms.api.event.group.GroupDataRecalculateEvent
Gets the group whose data was recalculated
getGroup() - Method in interface me.lucko.luckperms.api.event.group.GroupLoadEvent
Gets the group that was loaded
getGroup() - Method in interface me.lucko.luckperms.api.event.track.mutate.TrackAddGroupEvent
Gets the group that was added
getGroup() - Method in interface me.lucko.luckperms.api.event.track.mutate.TrackRemoveGroupEvent
Gets the group that was removed
getGroup(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped group object from the group storage
getGroup(String) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Gets a loaded group.
getGroupFrom() - Method in interface me.lucko.luckperms.api.DemotionResult
Gets the name of the group the user was demoted from, if applicable.
getGroupFrom() - Method in interface me.lucko.luckperms.api.event.user.track.UserTrackEvent
Gets the group the user was promoted/demoted from.
getGroupFrom() - Method in interface me.lucko.luckperms.api.PromotionResult
Gets the name of the group the user was promoted from, if applicable.
getGroupHistory(String) - Method in interface me.lucko.luckperms.api.Log
Gets the log content for a given group
getGroupManager() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the GroupManager, responsible for managing Group instances.
getGroupName() - Method in interface me.lucko.luckperms.api.event.group.GroupDeleteEvent
Gets the name of the deleted group
getGroupName() - Method in interface me.lucko.luckperms.api.Node
Gets the name of the inherited group if this node has InheritanceType type data, throwing an exception if the data is not present.
getGroupName() - Method in interface me.lucko.luckperms.api.nodetype.types.InheritanceType
Gets the name of the group to be inherited.
getGroupOpt(String) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Gets a loaded group.
getGroups() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a set of all loaded groups.
getGroups() - Method in interface me.lucko.luckperms.api.Track
Gets a list of the groups on this track
getGroupSafe(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped group object from the group storage.
getGroupsWithPermission(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
getGroupTo() - Method in interface me.lucko.luckperms.api.DemotionResult
Gets the name of the group the user was demoted from, if applicable.
getGroupTo() - Method in interface me.lucko.luckperms.api.event.user.track.UserTrackEvent
Gets the group the user was promoted/demoted to
getGroupTo() - Method in interface me.lucko.luckperms.api.PromotionResult
Gets the name of the group the user was promoted from, if applicable.
getHandlers(Class<T>) - Method in interface me.lucko.luckperms.api.event.EventBus
Gets a set of all registered handlers for a given event.
getHolder() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the holder of the permission
getId() - Method in interface me.lucko.luckperms.api.messenger.message.Message
Gets the unique id associated with this message.
getImmutableBacking() - Method in interface me.lucko.luckperms.api.caching.PermissionData
Gets an immutable copy of the permission map backing the permission calculator
getIncludeGlobalPerms() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets if the users on this server will have their global permissions applied
getIncludeGlobalWorldPerms() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets if the users on this server will have their global world permissions applied
getInstance() - Static method in class me.lucko.luckperms.api.FullySatisfiedContexts
 
getKey() - Method in interface me.lucko.luckperms.api.nodetype.types.MetaType
Gets the meta key.
getLoadedData() - Method in interface me.lucko.luckperms.api.event.group.GroupCacheLoadEvent
Gets the data that was loaded
getLoadedData() - Method in interface me.lucko.luckperms.api.event.user.UserCacheLoadEvent
Gets the data that was loaded
getLoadedGroups() - Method in interface me.lucko.luckperms.api.manager.GroupManager
Gets a set of all loaded groups.
getLoadedTracks() - Method in interface me.lucko.luckperms.api.manager.TrackManager
Gets a set of all loaded tracks.
getLoadedUsers() - Method in interface me.lucko.luckperms.api.manager.UserManager
Gets a set of all loaded users.
getLocation() - Method in interface me.lucko.luckperms.api.LocalizedNode
Gets the location where the Node is inherited from.
getLog() - Method in interface me.lucko.luckperms.api.ActionLogger
Gets a Log instance from the plugin storage.
getLog() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
getLogEntry() - Method in interface me.lucko.luckperms.api.messenger.message.type.LogMessage
Gets the log entry being sent
getLogId() - Method in interface me.lucko.luckperms.api.event.log.LogNetworkPublishEvent
Gets the ID of the log entry being published
getLogId() - Method in interface me.lucko.luckperms.api.event.log.LogReceiveEvent
Gets the ID of the log entry being received
getMergedNode() - Method in interface me.lucko.luckperms.api.TemporaryDataMutateResult
Gets the node that resulted from any TemporaryMergeBehaviour processing.
getMessagingService() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the MessagingService, if present.
getMeta() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets an immutable copy of the meta this user has.
getMeta() - Method in interface me.lucko.luckperms.api.Node
Gets the meta entry if this node has MetaType type data, throwing an exception if the data is not present.
getMetaContexts() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets the contexts this container is holding data for.
getMetaData(MetaContexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Gets MetaData from the cache, given a specified context.
getMetaData(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Gets MetaData from the cache, given a specified context.
getMetaMultimap() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets an immutable copy of the meta this user has.
getMetaStackFactory() - Method in interface me.lucko.luckperms.api.LuckPermsApi
getMiddleSpacer() - Method in interface me.lucko.luckperms.api.metastacking.MetaStackDefinition
Gets the spacer added between stack elements
getName() - Method in interface me.lucko.luckperms.api.Entity
Gets the name of the object
getName() - Method in interface me.lucko.luckperms.api.Group
Get the name of the group
getName() - Method in interface me.lucko.luckperms.api.MessagingService
Gets the name of this messaging service
getName() - Method in interface me.lucko.luckperms.api.messenger.MessengerProvider
Gets the name of this provider.
getName() - Method in interface me.lucko.luckperms.api.Storage
Get the name of the storage implementation.
getName(UUID) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
getName() - Method in interface me.lucko.luckperms.api.Track
Gets the name of this track
getName() - Method in interface me.lucko.luckperms.api.User
Gets the users username
getNext(Group) - Method in interface me.lucko.luckperms.api.Track
Gets the next group on the track, after the one provided
getNode() - Method in interface me.lucko.luckperms.api.event.node.NodeAddEvent
Gets the node that was added
getNode() - Method in interface me.lucko.luckperms.api.event.node.NodeRemoveEvent
Gets the node that was removed
getNode() - Method in interface me.lucko.luckperms.api.LocalizedNode
Gets the delegate node.
getNodeFactory() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the NodeFactory.
getNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets the backing multimap containing every permission this holder has.
getNotifiable() - Method in interface me.lucko.luckperms.api.event.log.LogNotifyEvent
Gets the object to be notified.
getObject(String) - Method in interface me.lucko.luckperms.api.LPConfiguration.Unsafe
Gets an Object from the config.
getObjectName() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets the objects generic name.
getOldUsername() - Method in interface me.lucko.luckperms.api.PlayerSaveResult
Gets the old username involved in the result
getOrigin() - Method in interface me.lucko.luckperms.api.event.log.LogBroadcastEvent
Gets where the log entry originated from.
getOrigin() - Method in interface me.lucko.luckperms.api.event.log.LogNotifyEvent
Gets where the log entry originated from.
getOtherUuids() - Method in interface me.lucko.luckperms.api.PlayerSaveResult
Gets the other uuids involved in the result
getOwnNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets a flattened/squashed view of the holders permissions.
getPattern() - Method in interface me.lucko.luckperms.api.nodetype.types.RegexType
Gets the pattern for the regex node.
getPatternString() - Method in interface me.lucko.luckperms.api.nodetype.types.RegexType
Gets the non-compiled pattern string.
getPermanentPermissionNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
A filtered view of this holders nodes, only including permanent entries.
getPermission() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the permission being held
getPermission() - Method in interface me.lucko.luckperms.api.Node
Gets the permission string this node encapsulates.
getPermissionData(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Gets PermissionData from the cache, given a specified context.
getPermissions() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets a sorted set of all held permissions.
getPermissionValue(String) - Method in interface me.lucko.luckperms.api.caching.PermissionData
Gets a permission check result for the given permission node.
getPlatformInfo() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets information about the platform LuckPerms is running on.
getPrefix() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets the user's highest priority prefix, or null if the user has no prefixes
getPrefix() - Method in interface me.lucko.luckperms.api.Node
Gets the prefix entry if this node has PrefixType type data, throwing an exception if the data is not present.
getPrefix() - Method in interface me.lucko.luckperms.api.nodetype.types.PrefixType
Gets the actual prefix string.
getPrefixes() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets an immutable sorted map of all of the prefixes the user has, whereby the first value is the highest priority prefix.
getPrefixStackDefinition() - Method in class me.lucko.luckperms.api.caching.MetaContexts
 
getPrefixStackDefinition() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets the definition used for the prefix stack
getPrevious(Group) - Method in interface me.lucko.luckperms.api.Track
Gets the previous group on the track, before the one provided
getPrimaryGroup() - Method in interface me.lucko.luckperms.api.User
Gets the users current primary group.
getPriority() - Method in interface me.lucko.luckperms.api.nodetype.types.PrefixType
Gets the priority of the prefix assignment.
getPriority() - Method in interface me.lucko.luckperms.api.nodetype.types.SuffixType
Gets the priority of the suffix assignment.
getResult() - Method in interface me.lucko.luckperms.api.event.player.PlayerDataSaveEvent
Gets the result of the operation.
getResult() - Method in interface me.lucko.luckperms.api.TemporaryDataMutateResult
Gets the underlying result.
getSecondsTilExpiry() - Method in interface me.lucko.luckperms.api.Node
Gets the number of seconds until this permission will expire.
getServer() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the server where the permission is held
getServer() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets the name of this server
getServer() - Method in interface me.lucko.luckperms.api.Node
Gets the server this node applies on, if the node is server specific.
getSettings() - Method in class me.lucko.luckperms.api.Contexts
Gets the set of LookupSettings which represent these Contexts.
getSize() - Method in interface me.lucko.luckperms.api.Track
Gets the number of groups on this track
getSource() - Method in interface me.lucko.luckperms.api.event.Sourced
Gets the events source.
getSplitStorage() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets true if split storage is enabled
getSplitStorageOptions() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets a map of split storage options
getStartSpacer() - Method in interface me.lucko.luckperms.api.metastacking.MetaStackDefinition
Gets the spacer string added before any stack elements
getStartTime() - Method in interface me.lucko.luckperms.api.platform.PlatformInfo
Gets the time when the plugin first started in milliseconds.
getStaticContext() - Method in interface me.lucko.luckperms.api.context.ContextManager
Gets the contexts from the static calculators in this manager.
getStaticContexts() - Method in interface me.lucko.luckperms.api.context.ContextManager
Gets the contexts from the static calculators in this manager.
getStatus() - Method in interface me.lucko.luckperms.api.DemotionResult
Gets the status of the result.
getStatus() - Method in interface me.lucko.luckperms.api.PlayerSaveResult
Gets the status returned by the operation
getStatus() - Method in interface me.lucko.luckperms.api.PromotionResult
Gets the status of the result.
getStorage() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets an object representing the plugins primary Storage backend.
getStorageMethod() - Method in interface me.lucko.luckperms.api.LPConfiguration
Gets the storage method string from the configuration
getSuffix() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets the user's highest priority suffix, or null if the user has no suffixes
getSuffix() - Method in interface me.lucko.luckperms.api.Node
Gets the suffix entry if this node has SuffixType type data, throwing an exception if the data is not present.
getSuffix() - Method in interface me.lucko.luckperms.api.nodetype.types.SuffixType
Gets the actual suffix string.
getSuffixes() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets an immutable sorted map of all of the suffixes the user has, whereby the first value is the highest priority suffix.
getSuffixStackDefinition() - Method in class me.lucko.luckperms.api.caching.MetaContexts
 
getSuffixStackDefinition() - Method in interface me.lucko.luckperms.api.caching.MetaData
Gets the definition used for the suffix stack
getSyncExecutor() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
as plugins should create their own executors
getSyncId() - Method in interface me.lucko.luckperms.api.event.sync.PreNetworkSyncEvent
Gets the ID of the sync request
getTarget() - Method in interface me.lucko.luckperms.api.event.node.NodeMutateEvent
Gets the target of the event
getTemporaryPermissionNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
A filtered view of this holders nodes, only including temporary entries.
getTimestamp() - Method in interface me.lucko.luckperms.api.LogEntry
Gets the time in unix seconds when the action occurred.
getTrack() - Method in interface me.lucko.luckperms.api.event.track.mutate.TrackMutateEvent
Gets the track that was mutated
getTrack() - Method in interface me.lucko.luckperms.api.event.track.TrackCreateEvent
Gets the new track
getTrack() - Method in interface me.lucko.luckperms.api.event.track.TrackLoadEvent
Gets the track that was loaded
getTrack() - Method in interface me.lucko.luckperms.api.event.user.track.UserTrackEvent
Gets the track involved in the event
getTrack(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped track object from the track storage
getTrack(String) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Gets a loaded track.
getTrackHistory(String) - Method in interface me.lucko.luckperms.api.Log
Gets the log content for a given track
getTrackManager() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the TrackManager, responsible for managing Track instances.
getTrackName() - Method in interface me.lucko.luckperms.api.event.track.TrackDeleteEvent
Gets the name of the deleted track
getTrackOpt(String) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Gets a loaded track.
getTracks() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a set of all loaded tracks.
getTrackSafe(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped track object from the track storage.
getTransientNodes() - Method in interface me.lucko.luckperms.api.PermissionHolder
Gets the backing multimap containing every transient permission this holder has.
getTransientPermissions() - Method in interface me.lucko.luckperms.api.PermissionHolder
Similar to PermissionHolder.getPermissions(), except only including permissions from the enduring node map.
getTristate() - Method in interface me.lucko.luckperms.api.Node
Gets the value of this node as a Tristate.
getType() - Method in interface me.lucko.luckperms.api.Entity
Gets the entities type.
getType() - Method in interface me.lucko.luckperms.api.event.source.Source
Gets the source type
getType() - Method in interface me.lucko.luckperms.api.LogEntry
Gets the type of action.
getType() - Method in interface me.lucko.luckperms.api.platform.PlatformInfo
Gets the type of platform LuckPerms is running on
getTypeData(NodeTypeKey<T>) - Method in interface me.lucko.luckperms.api.Node
Gets the type data corresponding to the given key, if present.
getTypeName() - Method in interface me.lucko.luckperms.api.nodetype.NodeTypeKey
Gets the class name of the represented type.
getUniqueConnections() - Method in interface me.lucko.luckperms.api.platform.PlatformInfo
Gets the unique players which have connected to the server since it started.
getUniqueId() - Method in interface me.lucko.luckperms.api.Entity
Gets the unique id of the entity, if it has one.
getUniqueUsers() - Method in interface me.lucko.luckperms.api.manager.UserManager
Gets a set all "unique" user UUIDs.
getUniqueUsers() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
getUser() - Method in interface me.lucko.luckperms.api.event.user.track.UserTrackEvent
Gets the user who was promoted or demoted
getUser() - Method in interface me.lucko.luckperms.api.event.user.UserCacheLoadEvent
Gets the user whose data was loaded
getUser() - Method in interface me.lucko.luckperms.api.event.user.UserDataRecalculateEvent
Gets the user whose data was recalculated
getUser() - Method in interface me.lucko.luckperms.api.event.user.UserLoadEvent
Gets the user that was loaded
getUser() - Method in interface me.lucko.luckperms.api.event.user.UserLoginProcessEvent
Gets the resultant User instance which was loaded.
getUser(UUID) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped user object from the user storage
getUser(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped user object from the user storage
getUser(UUID) - Method in interface me.lucko.luckperms.api.manager.UserManager
Gets a loaded user.
getUser(String) - Method in interface me.lucko.luckperms.api.manager.UserManager
Gets a loaded user.
getUser() - Method in interface me.lucko.luckperms.api.messenger.message.type.UserUpdateMessage
Gets the user the message is for.
getUserHistory(UUID) - Method in interface me.lucko.luckperms.api.Log
Gets the log content for a given user
getUserManager() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets the UserManager, responsible for managing User instances.
getUsername() - Method in interface me.lucko.luckperms.api.event.player.PlayerDataSaveEvent
Gets the username that was saved.
getUsername() - Method in interface me.lucko.luckperms.api.event.user.UserFirstLoginEvent
Gets the username of the user
getUsername() - Method in interface me.lucko.luckperms.api.event.user.UserLoginProcessEvent
Gets the username of the connection which was processed
getUserOpt(UUID) - Method in interface me.lucko.luckperms.api.manager.UserManager
Gets a loaded user.
getUserOpt(String) - Method in interface me.lucko.luckperms.api.manager.UserManager
Gets a loaded user.
getUsers() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a set of all loaded users.
getUserSafe(UUID) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped user object from the user storage.
getUserSafe(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Gets a wrapped user object from the user storage.
getUsersWithPermission(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
getUuid() - Method in interface me.lucko.luckperms.api.event.player.PlayerDataSaveEvent
Gets the unique ID that was saved.
getUuid() - Method in interface me.lucko.luckperms.api.event.user.UserFirstLoginEvent
Gets the UUID of the user
getUuid() - Method in interface me.lucko.luckperms.api.event.user.UserLoginProcessEvent
Gets the UUID of the connection which was processed
getUUID(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
getUuid() - Method in interface me.lucko.luckperms.api.User
Gets the users unique ID
getUUID(UUID) - Method in interface me.lucko.luckperms.api.UuidCache
Deprecated.
getUuidCache() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Deprecated.
this feature is now handled internally - and the API returns a No-op implementation of this class.
getValue() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the value of the permission
getValue() - Method in interface me.lucko.luckperms.api.Node
Gets the value of the node.
getValue() - Method in interface me.lucko.luckperms.api.nodetype.types.MetaType
Gets the meta value.
getValues(String) - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns a Set of the values mapped to the given key.
getVersion() - Method in interface me.lucko.luckperms.api.platform.PlatformInfo
Gets the plugin version
getWeight() - Method in interface me.lucko.luckperms.api.Group
Gets the weight of this group, if present.
getWeight() - Method in interface me.lucko.luckperms.api.nodetype.types.WeightType
Gets the weight value.
getWildcardLevel() - Method in interface me.lucko.luckperms.api.Node
Gets the level of this wildcard.
getWithPermission(String) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Searches for a list of groups with a given permission.
getWithPermission(String) - Method in interface me.lucko.luckperms.api.manager.UserManager
Searches for a list of users with a given permission.
getWorld() - Method in interface me.lucko.luckperms.api.HeldPermission
Gets the world where the permission is held
getWorld() - Method in interface me.lucko.luckperms.api.Node
Gets the world this node applies on, if the node is world specific.
giveApplicableContext(T, MutableContextSet) - Method in interface me.lucko.luckperms.api.context.ContextCalculator
Gives the subject all of the applicable contexts they meet
giveApplicableContext(MutableContextSet) - Method in interface me.lucko.luckperms.api.context.StaticContextCalculator
Adds this calculators context to the given accumulator.
giveApplicableContext(Object, MutableContextSet) - Method in interface me.lucko.luckperms.api.context.StaticContextCalculator
Deprecated.
global() - Static method in class me.lucko.luckperms.api.Contexts
Returns a 'global' or default contexts instance.
Group - Interface in me.lucko.luckperms.api
An inheritable holder of permission data.
GroupCacheLoadEvent - Interface in me.lucko.luckperms.api.event.group
Called when a groups GroupData is loaded.
GroupCreateEvent - Interface in me.lucko.luckperms.api.event.group
Called when a group is created
GroupData - Interface in me.lucko.luckperms.api.caching
Holds cached permission and meta lookup data for a Group.
GroupDataRecalculateEvent - Interface in me.lucko.luckperms.api.event.group
Called when a groups cached data is refreshed
GroupDeleteEvent - Interface in me.lucko.luckperms.api.event.group
Called when a group is deleted
GroupLoadAllEvent - Interface in me.lucko.luckperms.api.event.group
Called when all groups have been loaded in from storage.
GroupLoadEvent - Interface in me.lucko.luckperms.api.event.group
Called when a group is loaded into memory from the storage.
GroupManager - Interface in me.lucko.luckperms.api.manager
Represents the object responsible for managing Group instances.

H

has(String, String) - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns if the ContextSet contains a given context pairing.
has(Map.Entry<String, String>) - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns if the ContextSet contains a given context pairing.
hasExpired() - Method in interface me.lucko.luckperms.api.Node
Gets if the node has expired.
hashCode() - Method in class me.lucko.luckperms.api.caching.MetaContexts
 
hashCode() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
hashCode() - Method in class me.lucko.luckperms.api.Contexts
 
hashCode() - Method in class me.lucko.luckperms.api.FullySatisfiedContexts
 
hasPermission(Node, NodeEqualityPredicate) - Method in interface me.lucko.luckperms.api.PermissionHolder
Checks to see if the object has a certain permission.
hasPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Checks to see if the object has a certain permission.
hasSetting(LookupSetting) - Method in class me.lucko.luckperms.api.Contexts
Gets if the given LookupSetting is set.
hasSpecificContext() - Method in interface me.lucko.luckperms.api.Node
Gets if this node has any specific context in order for it to apply.
hasTransientPermission(Node, NodeEqualityPredicate) - Method in interface me.lucko.luckperms.api.PermissionHolder
Checks to see if the object has a certain permission.
hasTransientPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Checks to see if the object has a certain permission.
hasTypeData() - Method in interface me.lucko.luckperms.api.Node
Gets if this node has any extra NodeType data attached to it.
HeldPermission<T> - Interface in me.lucko.luckperms.api
A relationship between a PermissionHolder and a permission.

I

ImmutableContextSet - Class in me.lucko.luckperms.api.context
An immutable implementation of ContextSet.
ImmutableContextSet.Builder - Class in me.lucko.luckperms.api.context
A builder for ImmutableContextSet.
includes(PlayerSaveResult.Status) - Method in interface me.lucko.luckperms.api.PlayerSaveResult
Gets if the result includes a certain status code.
IncomingMessageConsumer - Interface in me.lucko.luckperms.api.messenger
Encapsulates the LuckPerms system which accepts incoming Messages from implementations of Messenger.
InheritanceType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to mark that the holder of the node should inherit from another group.
inheritsGroup(Group) - Method in interface me.lucko.luckperms.api.PermissionHolder
Check to see if this holder inherits another group in the global context.
inheritsGroup(Group, ContextSet) - Method in interface me.lucko.luckperms.api.PermissionHolder
Check to see if this holder inherits another group.
inheritsPermission(Node, NodeEqualityPredicate) - Method in interface me.lucko.luckperms.api.PermissionHolder
Checks to see if the object inherits a certain permission.
inheritsPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Checks to see if the object inherits a certain permission.
insertGroup(Group, int) - Method in interface me.lucko.luckperms.api.Track
Inserts a group at a certain position on this track
invalidateCache() - Method in interface me.lucko.luckperms.api.caching.PermissionData
Invalidates the underlying permission calculator cache.
invalidateCache(Object) - Method in interface me.lucko.luckperms.api.context.ContextManager
Invalidates the lookup cache for a given subject
invalidateMeta(MetaContexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Invalidates any cached MetaData instances mapped to the given MetaContexts.
invalidateMeta(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Invalidates any cached MetaData instances mapped to the given Contexts.
invalidateMeta() - Method in interface me.lucko.luckperms.api.caching.CachedData
Invalidates all cached MetaData instances.
invalidatePermissionCalculators() - Method in interface me.lucko.luckperms.api.caching.CachedData
Invalidates all of the underlying Permission calculators.
invalidatePermissions(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Invalidates any cached PermissionData instances mapped to the given Contexts.
invalidatePermissions() - Method in interface me.lucko.luckperms.api.caching.CachedData
Invalidates all cached PermissionData instances.
isAcceptingLogins() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
as this method always returns true.
isActive() - Method in interface me.lucko.luckperms.api.event.EventHandler
Returns true if this handler is active
isApplyGlobalGroups() - Method in class me.lucko.luckperms.api.Contexts
Deprecated.
isApplyGlobalWorldGroups() - Method in class me.lucko.luckperms.api.Contexts
Deprecated.
isApplyGroups() - Method in class me.lucko.luckperms.api.Contexts
Deprecated.
isCancelled() - Method in interface me.lucko.luckperms.api.event.Cancellable
Returns true if the event is currently cancelled.
isEmpty() - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns if the ContextSet is empty.
isGroup() - Method in interface me.lucko.luckperms.api.event.node.NodeMutateEvent
Gets whether the target of this event is a Group
isGroupLoaded(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Check if a group is loaded in memory
isGroupNode() - Method in interface me.lucko.luckperms.api.Node
Gets if this node has InheritanceType type data.
isImmutable() - Method in interface me.lucko.luckperms.api.context.ContextSet
Gets if this ContextSet is immutable.
isImmutable() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
isImmutable() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
isIncludeGlobal() - Method in class me.lucko.luckperms.api.Contexts
Deprecated.
isIncludeGlobalWorld() - Method in class me.lucko.luckperms.api.Contexts
Deprecated.
isLoaded(String) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Check if a group is loaded in memory
isLoaded(String) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Check if a track is loaded in memory
isLoaded(UUID) - Method in interface me.lucko.luckperms.api.manager.UserManager
Check if a user is loaded in memory
isMeta() - Method in interface me.lucko.luckperms.api.Node
Gets if this node has MetaType type data.
isNegated() - Method in interface me.lucko.luckperms.api.Node
Gets if the node is negated.
isNotCancelled() - Method in interface me.lucko.luckperms.api.event.Cancellable
Returns true if the event is not currently cancelled.
isOp() - Method in class me.lucko.luckperms.api.Contexts
Deprecated.
isOverride() - Method in interface me.lucko.luckperms.api.Node
Gets if this node is set to override explicitly.
isPermanent() - Method in interface me.lucko.luckperms.api.Node
Gets if this node is permanent (will not expire).
isPrefix() - Method in interface me.lucko.luckperms.api.Node
Gets if this node has PrefixType type data.
isSatisfiedBy(ContextSet) - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns if this ContextSet is fully "satisfied" by another set.
isServerSpecific() - Method in interface me.lucko.luckperms.api.Node
Gets if this node is server specific.
isSuffix() - Method in interface me.lucko.luckperms.api.Node
Gets if this node has SuffixType type data.
isTemporary() - Method in interface me.lucko.luckperms.api.Node
Gets if this node is assigned temporarily.
isTrackLoaded(String) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Check if a track is loaded in memory
isUser() - Method in interface me.lucko.luckperms.api.event.node.NodeMutateEvent
Gets whether the target of this event is a User
isUserLoaded(UUID) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Check if a user is loaded in memory
isWildcard() - Method in interface me.lucko.luckperms.api.Node
Gets if this node is a wildcard permission.
isWorldSpecific() - Method in interface me.lucko.luckperms.api.Node
Gets if this node is server specific.
iterator() - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns an Iterator over each of the context pairs in this set.
iterator() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
iterator() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 

K

KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.DisplayNameType
The key for this type.
KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.InheritanceType
The key for this type.
KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.MetaType
The key for this type.
KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.PrefixType
The key for this type.
KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.RegexType
The key for this type.
KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.SuffixType
The key for this type.
KEY - Static variable in interface me.lucko.luckperms.api.nodetype.types.WeightType
The key for this type.

L

loadAllGroups() - Method in interface me.lucko.luckperms.api.manager.GroupManager
Loads all groups into memory.
loadAllGroups() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
loadAllTracks() - Method in interface me.lucko.luckperms.api.manager.TrackManager
Loads all tracks into memory.
loadAllTracks() - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
loadGroup(String) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Loads a group from the plugin's storage provider into memory.
loadGroup(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
loadTrack(String) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Loads a track from the plugin's storage provider into memory.
loadTrack(String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
loadUser(UUID, String) - Method in interface me.lucko.luckperms.api.manager.UserManager
Loads a user from the plugin's storage provider into memory.
loadUser(UUID) - Method in interface me.lucko.luckperms.api.manager.UserManager
Loads a user from the plugin's storage provider into memory.
loadUser(UUID, String) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
loadUser(UUID) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
LocalizedNode - Interface in me.lucko.luckperms.api
An extension of Node, providing information about where the node originated from.
Log - Interface in me.lucko.luckperms.api
Represents the internal LuckPerms log.
logAction(LogEntry) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
LogBroadcastEvent - Interface in me.lucko.luckperms.api.event.log
Called when a log entry is about to be sent to notifiable players on the platform
LogBroadcastEvent.Origin - Enum in me.lucko.luckperms.api.event.log
Represents where a log entry is from
LogEntry - Interface in me.lucko.luckperms.api
Represents a logged action.
LogEntry.Builder - Interface in me.lucko.luckperms.api
Builds a LogEntry instance
LogEntry.Type - Enum in me.lucko.luckperms.api
Represents the type of a LogEntry.
LogMessage - Interface in me.lucko.luckperms.api.messenger.message.type
Represents an "log" message.
LogNetworkPublishEvent - Interface in me.lucko.luckperms.api.event.log
Called when a log is about to be published to the network via the MessagingService
LogNotifyEvent - Interface in me.lucko.luckperms.api.event.log
Called when a log entry is about to be sent to specific notifiable object on the platform.
LogNotifyEvent.Origin - Enum in me.lucko.luckperms.api.event.log
Represents where a log entry is from
LogPublishEvent - Interface in me.lucko.luckperms.api.event.log
Called when a log is about to be published to the storage file/table
LogReceiveEvent - Interface in me.lucko.luckperms.api.event.log
Called when a log entry is received via the MessagingService
lookupApplicableContext(User) - Method in interface me.lucko.luckperms.api.context.ContextManager
Queries the ContextManager for current context values for the given User.
lookupApplicableContexts(User) - Method in interface me.lucko.luckperms.api.context.ContextManager
Queries the ContextManager for current context values for the given User.
LookupSetting - Enum in me.lucko.luckperms.api
The various lookup setting flags for Contexts.
lookupUsername(UUID) - Method in interface me.lucko.luckperms.api.manager.UserManager
Uses the LuckPerms cache to find a username for the given uuid.
lookupUuid(String) - Method in interface me.lucko.luckperms.api.manager.UserManager
Uses the LuckPerms cache to find a uuid for the given username.
LPConfiguration - Interface in me.lucko.luckperms.api
Wrapper around parts of the LuckPerms configuration file
LPConfiguration.Unsafe - Interface in me.lucko.luckperms.api
 
LuckPerms - Class in me.lucko.luckperms
Provides static access to the LuckPermsApi.
LuckPermsApi - Interface in me.lucko.luckperms.api
The LuckPerms API.
LuckPermsEvent - Interface in me.lucko.luckperms.api.event
A superinterface for all LuckPerms events.

M

makeChatMetaNode(ChatMetaType, int, String) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder for the given chat meta type
makeGroupNode(Group) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder from a group
makeGroupNode(String) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder from a group
makeImmutable() - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns an immutable representation of this ContextSet.
makeImmutable() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
Deprecated.
makeImmutable() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
makeMetaNode(String, String) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder from a key value pair
makePrefixNode(int, String) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder from a prefix string and priority
makeSuffixNode(int, String) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder from a prefix string and priority
matches(Node) - Method in enum me.lucko.luckperms.api.ChatMetaType
Returns if the passed node matches the type
me.lucko.luckperms - package me.lucko.luckperms
 
me.lucko.luckperms.api - package me.lucko.luckperms.api
 
me.lucko.luckperms.api.caching - package me.lucko.luckperms.api.caching
 
me.lucko.luckperms.api.context - package me.lucko.luckperms.api.context
 
me.lucko.luckperms.api.event - package me.lucko.luckperms.api.event
 
me.lucko.luckperms.api.event.cause - package me.lucko.luckperms.api.event.cause
 
me.lucko.luckperms.api.event.group - package me.lucko.luckperms.api.event.group
 
me.lucko.luckperms.api.event.log - package me.lucko.luckperms.api.event.log
 
me.lucko.luckperms.api.event.node - package me.lucko.luckperms.api.event.node
 
me.lucko.luckperms.api.event.player - package me.lucko.luckperms.api.event.player
 
me.lucko.luckperms.api.event.source - package me.lucko.luckperms.api.event.source
 
me.lucko.luckperms.api.event.sync - package me.lucko.luckperms.api.event.sync
 
me.lucko.luckperms.api.event.track - package me.lucko.luckperms.api.event.track
 
me.lucko.luckperms.api.event.track.mutate - package me.lucko.luckperms.api.event.track.mutate
 
me.lucko.luckperms.api.event.user - package me.lucko.luckperms.api.event.user
 
me.lucko.luckperms.api.event.user.track - package me.lucko.luckperms.api.event.user.track
 
me.lucko.luckperms.api.manager - package me.lucko.luckperms.api.manager
 
me.lucko.luckperms.api.messenger - package me.lucko.luckperms.api.messenger
 
me.lucko.luckperms.api.messenger.message - package me.lucko.luckperms.api.messenger.message
 
me.lucko.luckperms.api.messenger.message.type - package me.lucko.luckperms.api.messenger.message.type
 
me.lucko.luckperms.api.metastacking - package me.lucko.luckperms.api.metastacking
 
me.lucko.luckperms.api.nodetype - package me.lucko.luckperms.api.nodetype
 
me.lucko.luckperms.api.nodetype.types - package me.lucko.luckperms.api.nodetype.types
 
me.lucko.luckperms.api.platform - package me.lucko.luckperms.api.platform
 
Message - Interface in me.lucko.luckperms.api.messenger.message
Represents a message sent received via a Messenger.
MessagingService - Interface in me.lucko.luckperms.api
A means to push changes to other servers using the platforms networking
Messenger - Interface in me.lucko.luckperms.api.messenger
Represents an object which dispatches OutgoingMessages.
MessengerProvider - Interface in me.lucko.luckperms.api.messenger
Represents a provider for Messenger instances.
MetaContexts - Class in me.lucko.luckperms.api.caching
Encapsulates the options and settings for a meta lookup.
MetaContexts(Contexts, MetaStackDefinition, MetaStackDefinition) - Constructor for class me.lucko.luckperms.api.caching.MetaContexts
Creates a new meta contexts instance
MetaData - Interface in me.lucko.luckperms.api.caching
Holds cached meta lookup data for a specific set of contexts.
MetaStackDefinition - Interface in me.lucko.luckperms.api.metastacking
Represents a meta stack model, consisting of a chain of elements, separated by spacers.
MetaStackElement - Interface in me.lucko.luckperms.api.metastacking
Represents an element within a MetaStackDefinition.
MetaStackFactory - Interface in me.lucko.luckperms.api.metastacking
Factory to create meta stack elements and definitions.
MetaType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to store meta assignments.
MutableContextSet - Class in me.lucko.luckperms.api.context
A mutable implementation of ContextSet.
MutableContextSet() - Constructor for class me.lucko.luckperms.api.context.MutableContextSet
 
mutableCopy() - Method in interface me.lucko.luckperms.api.context.ContextSet
Creates a mutable copy of this ContextSet.
mutableCopy() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
mutableCopy() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
MutateResult - Interface in me.lucko.luckperms.api
Represents the result to a "mutation" on an object.

N

newBuilder(String) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a new node builder from a given base permission string
newBuilderFromExisting(Node) - Method in interface me.lucko.luckperms.api.NodeFactory
Creates a node builder instance from an existing node
newEntryBuilder() - Method in interface me.lucko.luckperms.api.ActionLogger
Returns a new LogEntry.Builder instance
newLogEntryBuilder() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Returns a new LogEntry Builder instance
Node - Interface in me.lucko.luckperms.api
Represents a LuckPerms "node".
Node.Builder - Interface in me.lucko.luckperms.api
Builds a Node instance
NodeAddEvent - Interface in me.lucko.luckperms.api.event.node
Called when a node is added to a holder
NodeClearEvent - Interface in me.lucko.luckperms.api.event.node
Called when a holder has their nodes cleared
NodeEqualityPredicate - Interface in me.lucko.luckperms.api
A rule for determining if two nodes are equal.
NodeFactory - Interface in me.lucko.luckperms.api
Assists with constructing Node instances.
NodeMutateEvent - Interface in me.lucko.luckperms.api.event.node
Called when a node is added to/removed from a user/group
NodeRemoveEvent - Interface in me.lucko.luckperms.api.event.node
Called when a node is removed from a holder
NodeType - Interface in me.lucko.luckperms.api.nodetype
Superinterface for extended Node types.
NodeTypeKey<N extends NodeType> - Interface in me.lucko.luckperms.api.nodetype
Marks an instance used as a key for a NodeType.

O

obtain(IncomingMessageConsumer) - Method in interface me.lucko.luckperms.api.messenger.MessengerProvider
Creates and returns a new Messenger instance, which passes incoming messages to the provided IncomingMessageConsumer.
of(Contexts, MetaStackDefinition, MetaStackDefinition) - Static method in class me.lucko.luckperms.api.caching.MetaContexts
Creates a new meta contexts instance
of(String, String, String, String) - Static method in interface me.lucko.luckperms.api.context.ContextSet
Creates an ImmutableContextSet from two context pairs.
of(String, String, String, String) - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Creates an ImmutableContextSet from two context pairs.
of(String, String, String, String) - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a MutableContextSet from two context pairs.
of(ContextSet, boolean, boolean, boolean, boolean, boolean, boolean) - Static method in class me.lucko.luckperms.api.Contexts
Creates a new Contexts instance.
of(ContextSet, Set<LookupSetting>) - Static method in class me.lucko.luckperms.api.Contexts
Creates a new Contexts instance.
ofNode(Node) - Static method in enum me.lucko.luckperms.api.ChatMetaType
Parses a ChatMetaType from the given node.
OutgoingMessage - Interface in me.lucko.luckperms.api.messenger.message
Represents an outgoing Message.

P

Param - Annotation Type in me.lucko.luckperms.api.event
Represents the position of a parameter within an event.
PermissionData - Interface in me.lucko.luckperms.api.caching
Holds cached permission lookup data for a specific set of contexts.
PermissionHolder - Interface in me.lucko.luckperms.api
Generic superinterface for an object which holds permissions.
PlatformInfo - Interface in me.lucko.luckperms.api.platform
Provides information about the platform LuckPerms is running on.
PlatformType - Enum in me.lucko.luckperms.api.platform
Represents a type of platform which LuckPerms can run on.
PlayerDataSaveEvent - Interface in me.lucko.luckperms.api.event.player
Called when player data is saved to the storage.
PlayerSaveResult - Interface in me.lucko.luckperms.api
Encapsulates the result of an operation to save uuid data about a player.
PlayerSaveResult.Status - Enum in me.lucko.luckperms.api
The various states the result can take
PostSyncEvent - Interface in me.lucko.luckperms.api.event.sync
Called when an sync task has been completed
preCalculate(Set<Contexts>) - Method in interface me.lucko.luckperms.api.caching.CachedData
Pre-calculates and caches PermissionData and MetaData instances for the given contexts.
preCalculate(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
Pre-calculates and caches PermissionData and MetaData instances for a given context.
PrefixType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to store prefix assignments.
PreNetworkSyncEvent - Interface in me.lucko.luckperms.api.event.sync
Called before a received network sync task runs
PreSyncEvent - Interface in me.lucko.luckperms.api.event.sync
Called before a sync task runs
promote(User, ContextSet) - Method in interface me.lucko.luckperms.api.Track
Promotes the given user along this track.
PromotionResult - Interface in me.lucko.luckperms.api
Encapsulates the result of Users promotion along a Track.
PromotionResult.Status - Enum in me.lucko.luckperms.api
The result status
pushUpdate() - Method in interface me.lucko.luckperms.api.MessagingService
Uses the messaging service to inform other servers about a general change.
pushUserUpdate(User) - Method in interface me.lucko.luckperms.api.MessagingService
Uses the messaging service to inform other servers about a change to a specific user.

R

recalculateMeta(MetaContexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
(Re)calculates meta data for a given context.
recalculateMeta(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
(Re)calculates meta data for a given context.
recalculateMeta() - Method in interface me.lucko.luckperms.api.caching.CachedData
Recalculates meta data for all known contexts.
recalculatePermissions(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
(Re)calculates permission data for a given context.
recalculatePermissions() - Method in interface me.lucko.luckperms.api.caching.CachedData
Recalculates permission data for all known contexts.
refreshCachedData() - Method in interface me.lucko.luckperms.api.PermissionHolder
Refreshes and applies any changes to the cached holder data.
refreshPermissions() - Method in interface me.lucko.luckperms.api.User
Deprecated.
Calling this method is no longer necessary. Permissions data is now refreshed on demand, as changes are made. Consider use of PermissionHolder.refreshCachedData() instead. This method is now implemented as a no-op.
RegexType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to store regex permissions.
registerCalculator(ContextCalculator<?>) - Method in interface me.lucko.luckperms.api.context.ContextManager
Registers a context calculator with the manager.
registerContextCalculator(ContextCalculator<?>) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Register a custom context calculator to the server
registerMessengerProvider(MessengerProvider) - Method in interface me.lucko.luckperms.api.LuckPermsApi
Registers a MessengerProvider for use by the platform.
registerStaticCalculator(StaticContextCalculator) - Method in interface me.lucko.luckperms.api.context.ContextManager
Registers a static context calculator with the manager.
reloadMeta(MetaContexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
(Re)loads meta data for a given context.
reloadMeta(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
(Re)loads meta data for a given context.
reloadMeta() - Method in interface me.lucko.luckperms.api.caching.CachedData
Reloads meta data for all known contexts.
reloadPermissions(Contexts) - Method in interface me.lucko.luckperms.api.caching.CachedData
(Re)loads permission data for a given context.
reloadPermissions() - Method in interface me.lucko.luckperms.api.caching.CachedData
Reloads permission data for all known contexts.
remove(String, String) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Removes a context from this set.
removeAll(String) - Method in class me.lucko.luckperms.api.context.MutableContextSet
Removes all contexts from this set with the given key.
removeGroup(Group) - Method in interface me.lucko.luckperms.api.Track
Removes a group from this track
removeGroup(String) - Method in interface me.lucko.luckperms.api.Track
Removes a group from this track
resolveInheritances(Contexts) - Method in interface me.lucko.luckperms.api.PermissionHolder
Recursively resolves this holders permissions.
resolveInheritances() - Method in interface me.lucko.luckperms.api.PermissionHolder
Recursively resolves this holders permissions.
resolveShorthand() - Method in interface me.lucko.luckperms.api.Node
Resolves any shorthand parts of this node and returns the full list of resolved nodes.
runUpdateTask() - Method in interface me.lucko.luckperms.api.LuckPermsApi
Schedules the execution of an update task, and returns an encapsulation of the task as a CompletableFuture.

S

saveGroup(Group) - Method in interface me.lucko.luckperms.api.manager.GroupManager
Saves a group's data back to the plugin's storage provider.
saveGroup(Group) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
savePlayerData(UUID, String) - Method in interface me.lucko.luckperms.api.manager.UserManager
Saves data about a player to the uuid caching system.
saveTrack(Track) - Method in interface me.lucko.luckperms.api.manager.TrackManager
Saves a track's data back to the plugin's storage provider.
saveTrack(Track) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
saveUser(User) - Method in interface me.lucko.luckperms.api.manager.UserManager
Saves a user's data back to the plugin's storage provider.
saveUser(User) - Method in interface me.lucko.luckperms.api.Storage
Deprecated.
saveUUIDData(String, UUID) - Method in interface me.lucko.luckperms.api.Storage
sendOutgoingMessage(OutgoingMessage) - Method in interface me.lucko.luckperms.api.messenger.Messenger
Performs the necessary action to dispatch the message using the means of the messenger.
SERVER_KEY - Static variable in class me.lucko.luckperms.api.Contexts
The context key used to denote the subjects server
setActed(UUID) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the acted object for the entry.
setActedName(String) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the acted name for the entry.
setAction(String) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the action of the entry.
setActor(UUID) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the actor of the entry.
setActorName(String) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the actor name of the entry.
setCancelled(boolean) - Method in interface me.lucko.luckperms.api.event.Cancellable
Sets the cancellation state of the event.
setExpiry(long) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the time when the node should expire.
setExpiry(long, TimeUnit) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the time when the node should expire.
setExtraContext(ContextSet) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the extra contexts for the node.
setNegated(boolean) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the value of negated for the node.
setOverride(boolean) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the override property for the node.
setPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Sets a permission node for the permission holder.
setPermission(Node, TemporaryMergeBehaviour) - Method in interface me.lucko.luckperms.api.PermissionHolder
Sets a permission node for the permission holder.
setPermissionUnchecked(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Deprecated.
setPrimaryGroup(String) - Method in interface me.lucko.luckperms.api.User
Sets a users primary group.
setServer(String) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the server value for the node.
setTimestamp(long) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the timestamp of the entry.
setTransientPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Sets a transient permission for the permission holder.
setTransientPermission(Node, TemporaryMergeBehaviour) - Method in interface me.lucko.luckperms.api.PermissionHolder
Sets a transient permission for the permission holder.
setTransientPermissionUnchecked(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
setType(LogEntry.Type) - Method in interface me.lucko.luckperms.api.LogEntry.Builder
Sets the type of the entry.
setupDataCache() - Method in interface me.lucko.luckperms.api.User
Deprecated.
Use of this method is no longer necessary. It is implemented as a no-op.
setValue(boolean) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the value of the node.
setValue(String) - Method in interface me.lucko.luckperms.api.nodetype.types.MetaType
Deprecated.
setWorld(String) - Method in interface me.lucko.luckperms.api.Node.Builder
Sets the world value for the node.
shouldAccumulate(LocalizedNode, ChatMetaType, Map.Entry<Integer, String>) - Method in interface me.lucko.luckperms.api.metastacking.MetaStackElement
Returns if the given node should be accumulated onto the stack.
shouldApplyWithContext(ContextSet) - Method in interface me.lucko.luckperms.api.Node
Gets if this node should apply in the given context
shouldIgnore(Node) - Method in enum me.lucko.luckperms.api.ChatMetaType
Returns if the passed node should be ignored when searching for meta of this type
singleton(String, String) - Static method in interface me.lucko.luckperms.api.context.ContextSet
Creates an ImmutableContextSet from a context pair.
singleton(String, String) - Static method in class me.lucko.luckperms.api.context.ImmutableContextSet
Creates an ImmutableContextSet from a context pair.
singleton(String, String) - Static method in class me.lucko.luckperms.api.context.MutableContextSet
Creates a MutableContextSet from a context pair.
size() - Method in interface me.lucko.luckperms.api.context.ContextSet
Gets the number of context pairs in the ContextSet.
Source - Interface in me.lucko.luckperms.api.event.source
Represents the source of an event.
Source.Type - Enum in me.lucko.luckperms.api.event.source
Represents a type of source
Sourced - Interface in me.lucko.luckperms.api.event
Represents an event with a Source.
spliterator() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
spliterator() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
standardEquals(Node, StandardNodeEquality) - Method in interface me.lucko.luckperms.api.Node
Gets if this Node is equal to another node as defined by the given StandardNodeEquality predicate.
StandardNodeEquality - Enum in me.lucko.luckperms.api
StaticContextCalculator - Interface in me.lucko.luckperms.api.context
Extension of ContextCalculator which provides the same context regardless of the subject.
Storage - Interface in me.lucko.luckperms.api
A means of loading and saving permission data to/from the backend.
submit(LogEntry) - Method in interface me.lucko.luckperms.api.ActionLogger
Submits a log entry to the plugin to be handled.
submitToStorage(LogEntry) - Method in interface me.lucko.luckperms.api.ActionLogger
Submits a log entry to the plugins storage handler.
subscribe(Class<T>, Consumer<? super T>) - Method in interface me.lucko.luckperms.api.event.EventBus
Registers a new subscription to the given event.
subscribe(Object, Class<T>, Consumer<? super T>) - Method in interface me.lucko.luckperms.api.event.EventBus
Registers a new subscription to the given event.
SuffixType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to store suffix assignments.

T

TemporaryDataMutateResult - Interface in me.lucko.luckperms.api
Extension of DataMutateResult for temporary set operations.
TemporaryMergeBehaviour - Enum in me.lucko.luckperms.api
Controls how the implementation should behave when new temporary nodes are set that would otherwise conflict with existing entries.
toBuilder() - Method in interface me.lucko.luckperms.api.Node
Constructs a new builder initially containing the current properties of this node.
toMap() - Method in interface me.lucko.luckperms.api.context.ContextSet
Deprecated.
because the resultant map may not contain all data in the ContextSet
toMap() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
Deprecated.
toMap() - Method in class me.lucko.luckperms.api.context.MutableContextSet
Deprecated.
toMultimap() - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns a Multimap representing the current state of this ContextSet.
toMultimap() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
toMultimap() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
toSet() - Method in interface me.lucko.luckperms.api.context.ContextSet
Returns a Set of Map.Entrys representing the current state of this ContextSet.
toSet() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
toSet() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
toString() - Method in class me.lucko.luckperms.api.caching.MetaContexts
 
toString() - Method in enum me.lucko.luckperms.api.ChatMetaType
 
toString() - Method in class me.lucko.luckperms.api.context.ImmutableContextSet
 
toString() - Method in class me.lucko.luckperms.api.context.MutableContextSet
 
toString() - Method in class me.lucko.luckperms.api.Contexts
 
toString() - Method in class me.lucko.luckperms.api.FullySatisfiedContexts
 
Track - Interface in me.lucko.luckperms.api
An ordered chain of Groups.
TrackAction - Enum in me.lucko.luckperms.api.event.user.track
Represents the type of action performed in a UserTrackEvent
TrackAddGroupEvent - Interface in me.lucko.luckperms.api.event.track.mutate
Called when a group is added to a track
TrackClearEvent - Interface in me.lucko.luckperms.api.event.track.mutate
Called when a track is cleared
TrackCreateEvent - Interface in me.lucko.luckperms.api.event.track
Called when a track is created
TrackDeleteEvent - Interface in me.lucko.luckperms.api.event.track
Called when a track is deleted
TrackLoadAllEvent - Interface in me.lucko.luckperms.api.event.track
Called when all tracks have been loaded in from storage.
TrackLoadEvent - Interface in me.lucko.luckperms.api.event.track
Called when a track is loaded into memory from the storage.
TrackManager - Interface in me.lucko.luckperms.api.manager
Represents the object responsible for managing Track instances.
TrackMutateEvent - Interface in me.lucko.luckperms.api.event.track.mutate
Called when a track is changed
TrackRemoveGroupEvent - Interface in me.lucko.luckperms.api.event.track.mutate
Called when a group is removed from a track
Tristate - Enum in me.lucko.luckperms.api
Represents three different states of a setting.
typeData(NodeTypeKey<T>) - Method in interface me.lucko.luckperms.api.Node
Gets the type data corresponding to the given key, throwing an exception if no data is present.

U

unregister() - Method in interface me.lucko.luckperms.api.event.EventHandler
Unregisters this handler from the event bus
unsafe() - Method in interface me.lucko.luckperms.api.LPConfiguration
 
unsetPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Unsets a permission for the permission holder.
unsetPermissionUnchecked(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Deprecated.
unsetTransientPermission(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
Unsets a transient permission for the permission holder.
unsetTransientPermissionUnchecked(Node) - Method in interface me.lucko.luckperms.api.PermissionHolder
UpdateMessage - Interface in me.lucko.luckperms.api.messenger.message.type
Represents an "update" message.
User - Interface in me.lucko.luckperms.api
A player which holds permission data.
UserCacheLoadEvent - Interface in me.lucko.luckperms.api.event.user
Called when a users UserData is loaded.
UserData - Interface in me.lucko.luckperms.api.caching
Holds cached permission and meta lookup data for a User.
UserDataRecalculateEvent - Interface in me.lucko.luckperms.api.event.user
Called when a users cached data is refreshed
UserDemoteEvent - Interface in me.lucko.luckperms.api.event.user.track
Called when a user is demoted down a track.
UserFirstLoginEvent - Interface in me.lucko.luckperms.api.event.user
Called when the user logs into the network for the first time.
UserLoadEvent - Interface in me.lucko.luckperms.api.event.user
Called when a user is loaded into memory from the storage.
UserLoginProcessEvent - Interface in me.lucko.luckperms.api.event.user
Called when LuckPerms has finished processing a certain Player's connection.
UserManager - Interface in me.lucko.luckperms.api.manager
Represents the object responsible for managing User instances.
UserPromoteEvent - Interface in me.lucko.luckperms.api.event.user.track
Called when a user is promoted up a track.
UserTrackEvent - Interface in me.lucko.luckperms.api.event.user.track
Called when a user interacts with a track through a promotion or demotion
UserUpdateMessage - Interface in me.lucko.luckperms.api.messenger.message.type
Represents an "user update" message.
UuidCache - Interface in me.lucko.luckperms.api
Deprecated.
this feature is now handled internally - and the API returns a No-op implementation of this class.

V

valueOf(String) - Static method in enum me.lucko.luckperms.api.ChatMetaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.DataMutateResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.DemotionResult.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.Entity.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.event.cause.CreationCause
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.event.cause.DeletionCause
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.event.log.LogBroadcastEvent.Origin
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.event.log.LogNotifyEvent.Origin
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.event.source.Source.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.event.user.track.TrackAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.LogEntry.Type
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum me.lucko.luckperms.api.LogEntry.Type
 
valueOf(String) - Static method in enum me.lucko.luckperms.api.LookupSetting
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.platform.PlatformType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.PlayerSaveResult.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.PromotionResult.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.StandardNodeEquality
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.TemporaryMergeBehaviour
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.lucko.luckperms.api.Tristate
Returns the enum constant of this type with the specified name.
values() - Static method in enum me.lucko.luckperms.api.ChatMetaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.DataMutateResult
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.DemotionResult.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.Entity.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.event.cause.CreationCause
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.event.cause.DeletionCause
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.event.log.LogBroadcastEvent.Origin
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.event.log.LogNotifyEvent.Origin
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.event.source.Source.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.event.user.track.TrackAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.LogEntry.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.LookupSetting
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.platform.PlatformType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.PlayerSaveResult.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.PromotionResult.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.StandardNodeEquality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.TemporaryMergeBehaviour
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.lucko.luckperms.api.Tristate
Returns an array containing the constants of this enum type, in the order they are declared.

W

wasFailure() - Method in interface me.lucko.luckperms.api.MutateResult
Gets if the operation which produced this result failed.
wasSuccess() - Method in enum me.lucko.luckperms.api.DataMutateResult
 
wasSuccess() - Method in enum me.lucko.luckperms.api.DemotionResult.Status
 
wasSuccess() - Method in interface me.lucko.luckperms.api.DemotionResult
 
wasSuccess() - Method in interface me.lucko.luckperms.api.MutateResult
Gets if the operation which produced this result completed successfully.
wasSuccess() - Method in enum me.lucko.luckperms.api.PromotionResult.Status
 
wasSuccess() - Method in interface me.lucko.luckperms.api.PromotionResult
 
WeightType - Interface in me.lucko.luckperms.api.nodetype.types
A sub-type of Node used to mark the weight of the node's holder.
withExtraContext(String, String) - Method in interface me.lucko.luckperms.api.Node.Builder
Appends an extra context onto the node.
withExtraContext(Map<String, String>) - Method in interface me.lucko.luckperms.api.Node.Builder
Appends extra contexts onto the node.
withExtraContext(Set<Map.Entry<String, String>>) - Method in interface me.lucko.luckperms.api.Node.Builder
Appends extra contexts onto the node.
withExtraContext(Map.Entry<String, String>) - Method in interface me.lucko.luckperms.api.Node.Builder
Appends an extra context onto the node.
withExtraContext(ContextSet) - Method in interface me.lucko.luckperms.api.Node.Builder
Appends extra contexts onto the node.
WORLD_KEY - Static variable in class me.lucko.luckperms.api.Contexts
The context key used to denote the subjects world
A B C D E F G H I K L M N O P R S T U V W 
Skip navigation links