Package net.luckperms.api.platform

Interface PlayerAdapter<T>

Type Parameters:

T - the player type

public interface PlayerAdapter<T>

A utility class for adapting platform Player instances to LuckPerms Users.

Note: this class will only work for online players.

The "player type" parameter must be equal to the class or interface used by the server platform to represent players.

Specifically:

• org.bukkit.entity.Player
• net.md_5.bungee.api.connection.ProxiedPlayer
• org.spongepowered.api/entity.living.player.Player
• cn.nukkit.Player
• com.velocitypowered.api.proxy.Player

Since:

5.1

Method Summary

Modifier and Type	Method	Description
@NonNull ImmutableContextSet	getContext(@NonNull T player)	Gets current active context for the player.
default @NonNull CachedMetaData	getMetaData(@NonNull T player)	Gets the current CachedMetaData for the player, using their active query options.
default @NonNull CachedPermissionData	getPermissionData(@NonNull T player)	Gets the current CachedPermissionData for the player, using their active query options.
@NonNull QueryOptions	getQueryOptions(@NonNull T player)	Gets current active query options for the player.
@NonNull User	getUser(@NonNull T player)	Gets the User instance for the given player.

Method Details

getUser

@NonNull User getUser(@NonNull T player)

Gets the User instance for the given player.

Parameters:

player - the player

Returns:

the user

See Also:

• UserManager.getUser(UUID)

getContext

@NonNull ImmutableContextSet getContext(@NonNull T player)

Gets current active context for the player.

Parameters:

player - the player

Returns:

the active context for the player

See Also:

• ContextManager.getContext(Object)

getQueryOptions

@NonNull QueryOptions getQueryOptions(@NonNull T player)

Gets current active query options for the player.

Parameters:

player - the player

Returns:

the active query options for the player

See Also:

• ContextManager.getQueryOptions(Object)

getPermissionData

default @NonNull CachedPermissionData getPermissionData(@NonNull T player)

Gets the current CachedPermissionData for the player, using their active query options.

Parameters:

player - the player

Returns:

the cached permission data for the player

See Also:

• CachedDataManager.getPermissionData()

getMetaData

default @NonNull CachedMetaData getMetaData(@NonNull T player)

Gets the current CachedMetaData for the player, using their active query options.

Parameters:

player - the player

Returns:

the cached meta data for the player

See Also:

• CachedDataManager.getMetaData()