Package net.luckperms.api.node.metadata.types

Interface InheritanceOriginMetadata

@NonExtendable
public interface InheritanceOriginMetadata

Node metadata indicating where a node was inherited from.

Field Summary

Fields

Modifier and Type	Field	Description
static final NodeMetadataKey<InheritanceOriginMetadata>	KEY	The NodeMetadataKey for InheritanceOriginMetadata.

Method Summary

Modifier and Type	Method	Description
@NonNull DataType	getDataType()	Gets the type of the NodeMap the node was inherited from.
@NonNull PermissionHolder.Identifier	getOrigin()	Gets the location where the Node is inherited from.
default boolean	wasInherited(@NonNull PermissionHolder.Identifier holder)	Gets whether the associated node was inherited from another holder.

Field Details

KEY

static final NodeMetadataKey<InheritanceOriginMetadata> KEY

The NodeMetadataKey for InheritanceOriginMetadata.

Method Details

getOrigin

@NonNull PermissionHolder.Identifier getOrigin()

Gets the location where the Node is inherited from.

The resultant string is the object name of the permission holder the node was inherited from.

If the node was not inherited, the object name of the permission holder itself (the one that defined the node) will be returned.

Returns:

where the node was inherited from.

getDataType

@NonNull DataType getDataType()

Gets the type of the NodeMap the node was inherited from.

Returns:

the type of the NodeMap the node was inherited from.

Since:

5.4

wasInherited

default boolean wasInherited(@NonNull PermissionHolder.Identifier holder)

Gets whether the associated node was inherited from another holder.

In other terms, it returns whether the origin is not equal to the given holder.

Parameters:

holder - the holder defining the node

Returns:

if true the node was inherited, false if it was defined by the same holder

Since:

5.3