Package dev.kitteh.factions.permissible

Interface PermissibleAction

All Known Implementing Classes:

PermissibleAction.Simple, PermissibleAction.WithPrerequisite, PermissibleActions

@AvailableSince("4.0.0")
@NullMarked
public interface PermissibleAction

Permissible actions, such as the ability to open container blocks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	PermissibleAction.Simple	Simple little record for your convenience.
static final record	PermissibleAction.WithPrerequisite	Simple little record for your convenience.

Method Summary

Modifier and Type	Method	Description
String	description()	Long description, such as "Opening any block that can store items".
String	name()	Name of this permissible action.
@Nullable Upgrade	prerequisite()	Prerequisite for this permissible action to appear to users, if present.
String	shortDescription()	Short description text, such as "open containers".

Method Details

name

String name()

Name of this permissible action.

Returns:

name

description

String description()

Long description, such as "Opening any block that can store items".

Returns:

description

shortDescription

String shortDescription()

Short description text, such as "open containers".

Returns:

short description

prerequisite

@Nullable Upgrade prerequisite()

Prerequisite for this permissible action to appear to users, if present.

Returns:

prerequisite or null if not present