Package net.neoforged.neoforge.server.permission.handler

Class DefaultPermissionHandler

java.lang.Object

net.neoforged.neoforge.server.permission.handler.DefaultPermissionHandler

All Implemented Interfaces:

IPermissionHandler

public final class DefaultPermissionHandler
extends Object
implements IPermissionHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceLocation	IDENTIFIER
private Set<PermissionNode<?>>	immutableRegisteredNodes
private final Set<PermissionNode<?>>	registeredNodes

Constructor Summary

Constructors

Constructor	Description
DefaultPermissionHandler(Collection<PermissionNode<?>> permissions)

Method Summary

Modifier and Type	Method	Description
ResourceLocation	getIdentifier()	Returns an identifier for the PermissionHandler.
<T> T	getOfflinePermission(UUID player, PermissionNode<T> node, PermissionDynamicContext<?>... context)	See IPermissionHandler.getPermission(ServerPlayer, PermissionNode, PermissionDynamicContext[])
<T> T	getPermission(ServerPlayer player, PermissionNode<T> node, PermissionDynamicContext<?>... context)	Mods must use PermissionAPI.getPermission(ServerPlayer, PermissionNode, PermissionDynamicContext[])
Set<PermissionNode<?>>	getRegisteredNodes()	Returns an unmodifiable view of the collection of registered permission nodes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

IDENTIFIER

public static final ResourceLocation IDENTIFIER

registeredNodes

private final Set<PermissionNode<?>> registeredNodes

immutableRegisteredNodes

private Set<PermissionNode<?>> immutableRegisteredNodes

Constructor Details

DefaultPermissionHandler

public DefaultPermissionHandler(Collection<PermissionNode<?>> permissions)

Method Details

getIdentifier

public ResourceLocation getIdentifier()

Description copied from interface: IPermissionHandler

Returns an identifier for the PermissionHandler.

Specified by:

getIdentifier in interface IPermissionHandler

Returns:

an identifier for the PermissionHandler

getRegisteredNodes

public Set<PermissionNode<?>> getRegisteredNodes()

Description copied from interface: IPermissionHandler

Returns an unmodifiable view of the collection of registered permission nodes.

Specified by:

getRegisteredNodes in interface IPermissionHandler

Returns:

an unmodifiable view of the collection of registered permission nodes

getPermission

public <T> T getPermission(ServerPlayer player,
 PermissionNode<T> node,
 PermissionDynamicContext<?>... context)

Description copied from interface: IPermissionHandler

Mods must use PermissionAPI.getPermission(ServerPlayer, PermissionNode, PermissionDynamicContext[])

Queries a player's permission for a given node and contexts

Warning: PermissionNodes must be registered using the PermissionGatherEvent.Nodes event before querying.

Specified by:

getPermission in interface IPermissionHandler

Type Parameters:

T - type of the queried PermissionNode

Parameters:

player - player for which you want to check permissions

node - the PermissionNode for which you want to query

context - optional array of PermissionDynamicContext, single entries will be ignored if they weren't registered to the node

Returns:

a value of type <T>, that the combination of Player and PermissionNode map to.

getOfflinePermission

public <T> T getOfflinePermission(UUID player,
 PermissionNode<T> node,
 PermissionDynamicContext<?>... context)

Description copied from interface: IPermissionHandler

See IPermissionHandler.getPermission(ServerPlayer, PermissionNode, PermissionDynamicContext[])

Specified by:

getOfflinePermission in interface IPermissionHandler

Type Parameters:

T - type of the queried PermissionNode

Parameters:

player - offline player for which you want to check permissions

node - the PermissionNode for which you want to query

context - optional array of PermissionDynamicContext, single entries will be ignored if they weren't registered to the node

Returns:

a value of type <T>, that the combination of Player and PermissionNode map to.