Class RepeatAction

java.lang.Object

ua.mcchickenstudio.opencreative.coding.blocks.actions.Action

ua.mcchickenstudio.opencreative.coding.blocks.actions.MultiAction

ua.mcchickenstudio.opencreative.coding.blocks.actions.repeatactions.RepeatAction

All Implemented Interfaces:

CodingBlock

Direct Known Subclasses:

RepeatAlwaysAction, RepeatForBlocksAction, RepeatForEachAction, RepeatForEntryAction, RepeatForLoopAction, RepeatWhileConditionAction, RepeatWhileConditionNotAction

public abstract class RepeatAction
extends MultiAction

RepeatAction

This class represents a repeat action, that will execute actions for many times while condition is met.

Field Summary

Fields inherited from class Action

arguments, entity, event, handler

Modifier and Type	Field	Description
protected final Arguments	arguments
protected org.bukkit.entity.Entity	entity
protected WorldEvent	event
protected ActionsHandler	handler

Constructor Summary

Constructors

Constructor	Description
RepeatAction(Executor executor, Target target, int x, Arguments args, List<Action> actions)

Method Summary

Modifier and Type	Method	Description
abstract boolean	checkCanContinue()	Checks whether repeat action can continue repeating and executing the same actions.
protected void	execute(org.bukkit.entity.Entity entity)	Executes action with specified entity.
@NotNull ActionCategory	getActionCategory()	Returns category of action, that contains information about action: glass pane materials, block materials.
void	increaseCalls()	Increases call by 1 and checks limits.
void	repeat()
void	setMustStop(boolean mustStop)	Sets whether repeat action should stop repeating itself.

Methods inherited from class MultiAction

executeActions, getActions, prepareAndExecute

Modifier and Type	Method	Description
final void	executeActions()	Executes actions in new actions handler.
List<Action>	getActions()
final void	prepareAndExecute(@NotNull ActionsHandler handler)	Prepares action for executing, sets handler and event, and executes action with target.

Methods inherited from class Action

getActionType, getArguments, getArgumentsList, getEntitiesByNameOrUUID, getEntity, getEntityByNameOrUUID, getEvent, getExecutor, getHandler, getPlanet, getPlayersByNameOrUUID, getTarget, getTargets, getWorld, getX, getY, getZ, setEntity, setEvent, setHandler, setVarValue

Modifier and Type	Method	Description
abstract @NotNull ActionType	getActionType()	Returns type of action, that contains information about action: icon material, arguments list.
protected final @NotNull Arguments	getArguments()	Returns arguments of action.
List<Argument>	getArgumentsList()	Returns a list of all arguments in this action.
protected Set<org.bukkit.entity.Entity>	getEntitiesByNameOrUUID(String text)	Returns a set of entities whose name or UUID is equal to specified text.
org.bukkit.entity.Entity	getEntity()	Returns involved entity in action from ActionsHandler.
protected @Nullable org.bukkit.entity.Entity	getEntityByNameOrUUID(String text)	Returns an entity whose name or UUID is equal to specified text.
WorldEvent	getEvent()	Returns last stored event in action.
final Executor	getExecutor()	Returns executor, that stores this action.
ActionsHandler	getHandler()	Returns current ActionsHandler in action.
protected Planet	getPlanet()
protected Set<org.bukkit.entity.Player>	getPlayersByNameOrUUID(String text)
Target	getTarget()	Returns enum of target.
protected List<org.bukkit.entity.Entity>	getTargets()	Returns list of entities that will execute this action.
protected org.bukkit.World	getWorld()	Returns planet's world, where action will be executed.
int	getX()	Returns X coordinate of coding block's location.
int	getY()	Returns Y coordinate of coding block's location.
int	getZ()	Returns Z coordinate of coding block's location.
void	setEntity(org.bukkit.entity.Entity entity)	Sets entity involved in executor's event.
void	setEvent(WorldEvent event)	Sets new event.
void	setHandler(ActionsHandler handler)	Sets new ActionsHandler.
protected void	setVarValue(@Nullable VariableLink link, Object value)	Sets value in local, global or saved variable in world.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RepeatAction

public RepeatAction(Executor executor,
 Target target,
 int x,
 Arguments args,
 List<Action> actions)

Method Details

execute

protected void execute(org.bukkit.entity.Entity entity)

Description copied from class: Action

Executes action with specified entity.

Specified by:

execute in class Action

Parameters:

entity - Entity to execute action.

repeat

public void repeat()

increaseCalls

public void increaseCalls()

Increases call by 1 and checks limits.

setMustStop

public void setMustStop(boolean mustStop)

Sets whether repeat action should stop repeating itself.

Parameters:

mustStop - true - stop repeater, false - continue.

checkCanContinue

public abstract boolean checkCanContinue()

Checks whether repeat action can continue repeating and executing the same actions.

Returns:

true - can continue and execute actions, false - stop repeater.

getActionCategory

@NotNull
public @NotNull ActionCategory getActionCategory()

Description copied from class: Action

Returns category of action, that contains information about action: glass pane materials, block materials.

Specified by:

getActionCategory in class Action

Returns:

Category of action.