Class User

java.lang.Object

me.lucko.luckperms.common.model.PermissionHolder

me.lucko.luckperms.common.model.User

public class User
extends PermissionHolder

Constructor Summary

Constructors

Constructor	Description
User(UUID uniqueId, LuckPermsPlugin plugin)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ApiUser	getApiProxy()
UserCachedDataManager	getCachedData()	Gets the holders cached data
net.kyori.adventure.text.Component	getFormattedDisplayName()	Gets the formatted display name of this permission holder (for use in commands, etc)
String	getPlainDisplayName()	Gets a display name for this permission holder, without any formatting.
PrimaryGroupHolder	getPrimaryGroup()
net.luckperms.api.query.QueryOptions	getQueryOptions()	Gets the most appropriate query options available at the time for the holder.
HolderType	getType()	Returns the type of this PermissionHolder.
UUID	getUniqueId()
Optional<String>	getUsername()
int	hashCode()
boolean	setUsername(String name, boolean weak)	Sets the users name
String	toString()

Methods inherited from class PermissionHolder

accumulateMeta, accumulateMeta, auditTemporaryNodes, clearNodes, exportPermissions, getData, getIdentifier, getInheritanceComparator, getOwnInheritanceNodes, getOwnNodes, getOwnNodes, getOwnNodesSorted, getPlugin, getWeight, getWeightResult, hasNode, invalidateCache, loadNodesFromStorage, mergeNodes, normalData, removeIf, resolveInheritanceTree, resolveInheritedNodes, resolveInheritedNodes, resolveInheritedNodesSorted, setNode, setNode, setNodes, setNodes, transientData, unsetNode, unsetNode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

User

public User(UUID uniqueId,
 LuckPermsPlugin plugin)

Method Details

getUniqueId

public UUID getUniqueId()

getUsername

public Optional<String> getUsername()

getFormattedDisplayName

public net.kyori.adventure.text.Component getFormattedDisplayName()

Description copied from class: PermissionHolder

Gets the formatted display name of this permission holder (for use in commands, etc)

Specified by:

getFormattedDisplayName in class PermissionHolder

Returns:

the holders formatted display name

getPlainDisplayName

public String getPlainDisplayName()

Description copied from class: PermissionHolder

Gets a display name for this permission holder, without any formatting.

Specified by:

getPlainDisplayName in class PermissionHolder

Returns:

the display name

getQueryOptions

public net.luckperms.api.query.QueryOptions getQueryOptions()

Description copied from class: PermissionHolder

Gets the most appropriate query options available at the time for the holder.

Specified by:

getQueryOptions in class PermissionHolder

Returns:

query options

getApiProxy

public ApiUser getApiProxy()

getCachedData

public UserCachedDataManager getCachedData()

Description copied from class: PermissionHolder

Gets the holders cached data

Specified by:

getCachedData in class PermissionHolder

Returns:

the holders cached data

getPrimaryGroup

public PrimaryGroupHolder getPrimaryGroup()

setUsername

public boolean setUsername(String name,
 boolean weak)

Sets the users name

Parameters:

name - the name to set

weak - if true, the value will only be updated if a value hasn't been set previously.

Returns:

true if a change was made

getType

public HolderType getType()

Description copied from class: PermissionHolder

Returns the type of this PermissionHolder.

Specified by:

getType in class PermissionHolder

Returns:

this holders type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object