Class Function

java.lang.Object

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

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

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

All Implemented Interfaces:

CodingBlock, ExtensionContent

public final class Function
extends NameableExecutor

Function

This class represents a function, that executes actions in same actions handler.

Constructor Summary

Constructors

Constructor	Description
Function()

Method Summary

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.

Methods inherited from class NameableExecutor

getCallName, setCallName

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

Constructor Details

Function

public Function()

Method Details

getExtensionId

@NotNull
public @NotNull String getExtensionId()

Description copied from interface: ExtensionContent

Returns lower-cased simple id of extension. Will be used to identify author of content.

ID "default" is reserved for OpenCreative+ developers.

Returns:

id of extension.

getName

@NotNull
public @NotNull String getName()

Description copied from interface: ExtensionContent

Returns name of extension content. Will be displayed in list of extension content.

Returns:

name of content.

getDescription

@NotNull
public @NotNull String getDescription()

Description copied from interface: ExtensionContent

Returns description of extension content. Describes purpose of new additional content.

Returns:

description of content.