me.lucko.luckperms.api

Interface User

All Superinterfaces:

PermissionHolder

public interface User
extends PermissionHolder

A player which holds permission data.

Method Summary

Modifier and Type	Method and Description
UserData	getCachedData() Gets the user's UserData cache.
String	getName() Gets the users username
String	getPrimaryGroup() Gets the users current primary group.
UUID	getUuid() Gets the users unique ID
void	refreshPermissions() Deprecated. in favour of PermissionHolder.refreshCachedData().
DataMutateResult	setPrimaryGroup(String group) Sets a users primary group.
void	setupDataCache() Deprecated. because use of this method is no longer necessary.

Methods inherited from interface me.lucko.luckperms.api.PermissionHolder

auditTemporaryPermissions, clearMatching, clearMatchingTransient, clearMeta, clearMeta, clearNodes, clearNodes, clearParents, clearParents, clearTransientNodes, exportNodes, getAllNodes, getAllNodes, getAllNodesFiltered, getEnduringPermissions, getFriendlyName, getNodes, getObjectName, getOwnNodes, getPermanentPermissionNodes, getPermissions, getTemporaryPermissionNodes, getTransientNodes, getTransientPermissions, hasPermission, hasPermission, hasTransientPermission, hasTransientPermission, inheritsGroup, inheritsGroup, inheritsPermission, inheritsPermission, refreshCachedData, resolveInheritances, resolveInheritances, setPermission, setPermissionUnchecked, setTransientPermission, setTransientPermissionUnchecked, unsetPermission, unsetPermissionUnchecked, unsetTransientPermission, unsetTransientPermissionUnchecked

Method Detail

getUuid

@Nonnull
UUID getUuid()

Gets the users unique ID

Returns:

the users Mojang assigned unique id

getName

@Nullable
String getName()

Gets the users username

Returns null if no username is associated with this user.

Returns:

the users username

getPrimaryGroup

@Nonnull
String getPrimaryGroup()

Gets the users current primary group.

The result of this method depends on which method is configured for primary group calculation. It may not be the same as any value set through setPrimaryGroup(String).

Returns:

the users primary group

setPrimaryGroup

DataMutateResult setPrimaryGroup(@Nonnull
                                 String group)

Sets a users primary group. This will only take effect if platform is using stored primary groups.

Parameters:

group - the new primary group

Returns:

if the change was applied successfully

Throws:

IllegalStateException - if the user is not a member of that group

NullPointerException - if the group is null

getCachedData

@Nonnull
UserData getCachedData()

Gets the user's UserData cache.

Specified by:

getCachedData in interface PermissionHolder

Returns:

the users cached data.

Since:

3.2

refreshPermissions

@Deprecated
void refreshPermissions()

Deprecated. in favour of PermissionHolder.refreshCachedData().

Refresh and re-assign the users permissions.

This request is not buffered, and the refresh call will be ran directly. This should be called on an asynchronous thread.

setupDataCache

@Deprecated
void setupDataCache()

Deprecated. because use of this method is no longer necessary.

Pre-calculates some values in the user's data cache.

Is it not necessary to call this method before using getCachedData().

Since:

2.17