Class NameableExecutor

java.lang.Object

ua.mcchickenstudio.opencreative.coding.blocks.executors.Executor

ua.mcchickenstudio.opencreative.coding.blocks.executors.other.NameableExecutor

All Implemented Interfaces:

CodingBlock, ExtensionContent

Direct Known Subclasses:

Cycle, Function, Method

public abstract class NameableExecutor
extends Executor

NameableExecutor

This class represents an executor, that has name (custom id) to call it with other actions.

Constructor Summary

Constructors

Constructor	Description
NameableExecutor(@NotNull String id, @NotNull ExecutorCategory category)

Method Summary

Modifier and Type	Method	Description
final @NotNull String	getCallName()	Returns name of executor for calling it.
void	setCallName(@NotNull String name)	Sets name of executor for calling it.

Methods inherited from class Executor

decreaseCall, equals, executeActions, getActions, getBlockCategory, getEvent, getHandler, getID, getLastCalls, getLocaleName, getPlanet, getX, getY, getZ, hashCode, increaseCall, init, isDebug, isDisabled, run, setActions, setDebug, toString

Modifier and Type	Method	Description
final void	decreaseCall()	Decreases calls amount by 1.
final boolean	equals(Object obj)
protected void	executeActions(@NotNull WorldEvent event)	Executes all actions with specified event.
final @NotNull List<Action>	getActions()
final @NotNull ExecutorCategory	getBlockCategory()	Returns coding block category of this executor.
final WorldEvent	getEvent()	Returns last world event of executor.
final ActionsHandler	getHandler()
final @NotNull String	getID()	Returns id of executor, that will be used to find it in registry.
final int	getLastCalls()	Returns how many times executor was called to execute actions.
final @NotNull String	getLocaleName()	Returns localized name of executor.
final @NotNull Planet	getPlanet()	Returns planet, that was associated with executor.
final int	getX()	Returns X coordinate of coding block's location.
final int	getY()	Returns Y coordinate of coding block's location.
final int	getZ()	Returns Z coordinate of coding block's location.
final int	hashCode()
final void	increaseCall()	Increases calls amount by 1.
void	init(@NotNull Planet planet, int x, int y, int z)	Initializes an executor and sets planet and coding block location.
final boolean	isDebug()	Checks whether is executor block marked for debugging.
final boolean	isDisabled()	Checks whether executor is disabled and cannot be called.
void	run(@NotNull WorldEvent event)	Checks executor, executes actions and sends information about executor.
final void	setActions(@NotNull List<Action> actions)	Sets actions list for executor.
final void	setDebug(boolean debug)	Enables or disables sending debug logs about executor and actions inside.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface ExtensionContent

getDescription, getExtensionId, getName

Modifier and Type	Method	Description
@NotNull String	getDescription()	Returns description of extension content.
@NotNull String	getExtensionId()	Returns lower-cased simple id of extension.
@NotNull String	getName()	Returns name of extension content.

Constructor Details

NameableExecutor

public NameableExecutor(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull ExecutorCategory category)

Method Details

setCallName

public void setCallName(@NotNull
 @NotNull String name)

Sets name of executor for calling it.

Parameters:

name - new name to call it.

getCallName

@NotNull
public final @NotNull String getCallName()

Returns name of executor for calling it.

Returns:

custom id of executor.