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
@NonNull UserData	getCachedData() Gets the user's UserData cache.
@Nullable String	getName() Gets the users username
@NonNull String	getPrimaryGroup() Gets the users current primary group.
@NonNull UUID	getUuid() Gets the users unique ID
void	refreshPermissions() 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.
@NonNull DataMutateResult	setPrimaryGroup(@NonNull String group) Sets a users primary group.
void	setupDataCache() Deprecated. Use of this method is no longer necessary. It is implemented as a no-op.

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, setPermission, setPermissionUnchecked, setTransientPermission, 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 known for the 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

@NonNull DataMutateResult setPrimaryGroup(@NonNull String group)

Sets a users primary group.

This modifies the "stored value" for the users primary group, which may or may not actually take effect, depending on how the platform is calculating 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. 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.

Refresh and re-assign the users permissions.

setupDataCache

@Deprecated
void setupDataCache()

Deprecated. Use of this method is no longer necessary. It is implemented as a no-op.

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

Since:

2.17