Package net.neoforged.neoforge.server.permission.nodes

Class PermissionNode<T>

java.lang.Object

net.neoforged.neoforge.server.permission.nodes.PermissionNode<T>

public final class PermissionNode<T>
extends Object

Represents the basic unit at the heart of the permission system.

A permission indicates the ability for an actor to perform an action, in its most general sense. In the permission system, all permissions are encoded as instances of this class, optionally integrated by a PermissionDynamicContext.

A node is uniquely identified by its `nodeName`, which is a dot-separated string providing meaning to the node itself. The suggested structure of the name is `modid.name`, where `modid` is the ID of the owner of the node. This API does not require any implicit hierarchy, so `modid.name` is not considered a parent of `modid.name.sub`. Such decisions are left to the IPermissionHandler.

Each node also has an associated PermissionType, detailing its exact type, along with a PermissionNode.PermissionResolver that is used to obtain the default value of the permission. More information can be found on their documentation.

A node can also be bound to additional PermissionDynamicContextKeys, which are used when querying the availability of the permission. There are no restrictions on their amount. It is also not mandatory to provide a value for all dynamics in a permission query. See the above link for more information.

Each node should be registered via the PermissionGatherEvent.Nodes and stored statically in a field. That instance should then be reused every-time a permission check needs to be performed via PermissionAPI.getPermission(ServerPlayer, PermissionNode, PermissionDynamicContext[]).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PermissionNode.PermissionResolver<T>	Utility Interface used for resolving the default value of PermissionNodes

Field Summary

Fields

Modifier and Type	Field	Description
private final PermissionNode.PermissionResolver<T>	defaultResolver
private @Nullable Component	description
private final PermissionDynamicContextKey<?>[]	dynamics
private final String	nodeName
private @Nullable Component	readableName
private final PermissionType<T>	type

Constructor Summary

Constructors

Modifier	Constructor	Description
	PermissionNode(String modID, String nodeName, PermissionType<T> type, PermissionNode.PermissionResolver<T> defaultResolver, PermissionDynamicContextKey... dynamics)	Calls PermissionNode(String, PermissionType, PermissionResolver, PermissionDynamicContextKey[]) with "modid.nodename" as the first parameter
private	PermissionNode(String nodeName, PermissionType<T> type, PermissionNode.PermissionResolver<T> defaultResolver, PermissionDynamicContextKey... dynamics)
	PermissionNode(ResourceLocation nodeName, PermissionType<T> type, PermissionNode.PermissionResolver<T> defaultResolver, PermissionDynamicContextKey... dynamics)	Calls PermissionNode(String, PermissionType, PermissionResolver, PermissionDynamicContextKey[]) with "namespace.path" as the first parameter

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
PermissionNode.PermissionResolver<T>	getDefaultResolver()
@Nullable Component	getDescription()
PermissionDynamicContextKey<?>[]	getDynamics()
String	getNodeName()
@Nullable Component	getReadableName()
PermissionType<T>	getType()
int	hashCode()
PermissionNode	setInformation(Component readableName, Component description)	Allows you to set a human-readable name and description for your Permission.

Methods inherited from class java.lang.Object

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

Field Details

nodeName

private final String nodeName

type

private final PermissionType<T> type

defaultResolver

private final PermissionNode.PermissionResolver<T> defaultResolver

dynamics

private final PermissionDynamicContextKey<?>[] dynamics

readableName

@Nullable
private @Nullable Component readableName

description

@Nullable
private @Nullable Component description

Constructor Details

PermissionNode

public PermissionNode(ResourceLocation nodeName,
 PermissionType<T> type,
 PermissionNode.PermissionResolver<T> defaultResolver,
 PermissionDynamicContextKey... dynamics)

Calls PermissionNode(String, PermissionType, PermissionResolver, PermissionDynamicContextKey[]) with "namespace.path" as the first parameter

PermissionNode

public PermissionNode(String modID,
 String nodeName,
 PermissionType<T> type,
 PermissionNode.PermissionResolver<T> defaultResolver,
 PermissionDynamicContextKey... dynamics)

Calls PermissionNode(String, PermissionType, PermissionResolver, PermissionDynamicContextKey[]) with "modid.nodename" as the first parameter

PermissionNode

private PermissionNode(String nodeName,
 PermissionType<T> type,
 PermissionNode.PermissionResolver<T> defaultResolver,
 PermissionDynamicContextKey... dynamics)

Parameters:

nodeName - The identifier of a node, recommended identifier structure: "modid.path.for.node"

type - type object for the PermissionNode, only use types in PermissionTypes

defaultResolver - Default resolver for the permission, can but doesn't have to be used to by PermissionHandlers

dynamics - PermissionDynamicContextKey is a dynamic component for permission nodes, similar to BlockState Properties. They must be passed into the constructor if you want to use them.

Method Details

setInformation

public PermissionNode setInformation(Component readableName,
 Component description)

Allows you to set a human-readable name and description for your Permission.

Note: Even though not used by Default, PermissionHandlers may display this information in game, or provide it to the user by other means.
You may use translatable components, but you'll need 2 language files. One inside the data directory for the server and one inside assets for the client.

Parameters:

readableName - an easier to read name for the PermissionNode, when using TranslatableComponent, key should be of format "permission.name.<nodename>"

description - description for the PermissionNode when using TranslatableComponent, key should be of format "permission.desc.<nodename>"

Returns:

itself with the new information set.

getNodeName

public String getNodeName()

getType

public PermissionType<T> getType()

getDynamics

public PermissionDynamicContextKey<?>[] getDynamics()

getDefaultResolver

public PermissionNode.PermissionResolver<T> getDefaultResolver()

getReadableName

@Nullable
public @Nullable Component getReadableName()

getDescription

@Nullable
public @Nullable Component getDescription()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object