Interface AdditionsAction
public interface AdditionsAction
Custom AdditionsPlus action class.
Perform a consumer when this action is being called.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsTag
(String action) Get whether an action string contains this action tag.Get aList
of aliases for this action.Get theConsumer<QueuedAction>
that is called when this action is being performed.Get the identifier of this action.org.bukkit.plugin.Plugin
Get the BukkitPlugin
of this action.getType()
Get theActionType
of this action.boolean
Check if this action is a base action.boolean
Check if this action requires a player as executor to work.void
perform
(ActionSender sender, QueuedAction queuedAction) Perform this action for the sender.removeTagFromString
(String actionString) Remove this action tag from the given string.
-
Method Details
-
getPlugin
org.bukkit.plugin.Plugin getPlugin()Get the BukkitPlugin
of this action.- Returns:
Plugin
of this action.
-
getIdentifier
String getIdentifier()Get the identifier of this action.- Returns:
- Identifier of this action.
-
getType
ActionType getType()Get theActionType
of this action.- Returns:
ActionType
of this action.
-
getAliases
Get aList
of aliases for this action.- Returns:
List
of action aliases.
-
isRequirePlayer
boolean isRequirePlayer()Check if this action requires a player as executor to work.- Returns:
- True if enabled, false otherwise.
-
getConsumer
Consumer<QueuedAction> getConsumer()Get theConsumer<QueuedAction>
that is called when this action is being performed.- Returns:
Consumer<QueuedAction>
that is performed.
-
perform
Perform this action for the sender.- Parameters:
sender
- Sender to perform actions for.queuedAction
-QueuedAction
to perform.
-
containsTag
Get whether an action string contains this action tag.- Parameters:
action
- Action string to check.- Returns:
- True if it contains this action, false otherwise.
-
removeTagFromString
Remove this action tag from the given string.- Parameters:
actionString
- String to remove the action from.- Returns:
- String without this action tag.
-
isBaseAction
boolean isBaseAction()Check if this action is a base action.- Returns:
- true if it is a base action, false otherwise.
-