Class ActionForEach

java.lang.Object

com.hypixel.hytale.server.npc.corecomponents.AnnotatedComponentBase

com.hypixel.hytale.server.npc.corecomponents.ActionBase

com.hypixel.hytale.server.npc.corecomponents.utility.ActionSequence

com.hypixel.hytale.server.npc.corecomponents.utility.ActionForEach

All Implemented Interfaces:

Action, RoleStateChange, IAnnotatedComponent, IAnnotatedComponentCollection, IComponentExecutionControl

public class ActionForEach
extends ActionSequence

Runs its nested action list once for every target/position the sensor produced (see IPositionSet).

Field Summary

Fields inherited from interface Action

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ActionForEach(BuilderActionForEach builder, BuilderSupport support)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Store<EntityStore> store)	Test if an action can be executed
void	clearOnce()
boolean	execute(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Store<EntityStore> store)	Execute action
boolean	isBusy()	Whether this action has work in flight that spans ticks (e.g. a deferred/delayed continuation bound to this instance).
void	loaded(ExecutionSupport executionSupport)
void	motionControllerChanged(Ref<EntityStore> ref, NPCEntity npcComponent, MotionController motionController, ComponentAccessor<EntityStore> componentAccessor)
void	registerWithSupport(ExecutionSupport executionSupport)
void	removed(ExecutionSupport executionSupport)
void	setContext(IAnnotatedComponent parent, int index)
void	spawned(ExecutionSupport executionSupport)
void	teleported(ExecutionSupport executionSupport, World from, World to)
void	unloaded(ExecutionSupport executionSupport)

Methods inherited from class ActionSequence

componentCount, getComponent, setOnce

Methods inherited from class ActionBase

activate, deactivate, isActivated, isTriggered, processDelay

Methods inherited from class AnnotatedComponentBase

getIndex, getInfo, getParent

Methods inherited from class Object

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

Methods inherited from interface IAnnotatedComponent

getBreadCrumbs, getBreadCrumbs, getIndex, getInfo, getLabel, getParent

Constructor Details

ActionForEach

public ActionForEach(@Nonnull
 BuilderActionForEach builder,
 @Nonnull
 BuilderSupport support)

Method Details

canExecute

public boolean canExecute(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nullable
 InfoProvider sensorInfo,
 double dt,
 @Nonnull
 Store<EntityStore> store)

Description copied from interface: Action

Test if an action can be executed

Specified by:

canExecute in interface Action

Overrides:

canExecute in class ActionSequence

Parameters:

ref - The entity ref

executionSupport - The execution support

sensorInfo - SensorInfo with PositionProvider, PathProvider, etc if required

dt - The interval in seconds for this calculation

store - The component store

Returns:

true if action can be executed else false to skip execution

execute

public boolean execute(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nullable
 InfoProvider sensorInfo,
 double dt,
 @Nonnull
 Store<EntityStore> store)

Description copied from interface: Action

Execute action

Specified by:

execute in interface Action

Overrides:

execute in class ActionSequence

Parameters:

ref - The entity ref

executionSupport - The execution support

sensorInfo - SensorInfo with PositionProvider, PathProvider, etc if required

dt - The interval in seconds for this calculation

store - The component store

Returns:

true when executed action has finished else false when execution is not completed yet

isBusy

public boolean isBusy()

Description copied from interface: Action

Whether this action has work in flight that spans ticks (e.g. a deferred/delayed continuation bound to this instance). Used by ForEach's per-target instance pool to avoid recycling a slot whose action is still mid-execution. Defaults to false.

Specified by:

isBusy in interface Action

Overrides:

isBusy in class ActionSequence

registerWithSupport

public void registerWithSupport(ExecutionSupport executionSupport)

Specified by:

registerWithSupport in interface RoleStateChange

Overrides:

registerWithSupport in class ActionSequence

motionControllerChanged

public void motionControllerChanged(@Nullable
 Ref<EntityStore> ref,
 @Nonnull
 NPCEntity npcComponent,
 MotionController motionController,
 @Nullable
 ComponentAccessor<EntityStore> componentAccessor)

Specified by:

motionControllerChanged in interface RoleStateChange

Overrides:

motionControllerChanged in class ActionSequence

loaded

public void loaded(ExecutionSupport executionSupport)

Specified by:

loaded in interface RoleStateChange

Overrides:

loaded in class ActionSequence

spawned

public void spawned(ExecutionSupport executionSupport)

Specified by:

spawned in interface RoleStateChange

Overrides:

spawned in class ActionSequence

unloaded

public void unloaded(ExecutionSupport executionSupport)

Specified by:

unloaded in interface RoleStateChange

Overrides:

unloaded in class ActionSequence

removed

public void removed(ExecutionSupport executionSupport)

Specified by:

removed in interface RoleStateChange

Overrides:

removed in class ActionSequence

teleported

public void teleported(ExecutionSupport executionSupport,
 World from,
 World to)

Specified by:

teleported in interface RoleStateChange

Overrides:

teleported in class ActionSequence

clearOnce

public void clearOnce()

Specified by:

clearOnce in interface IComponentExecutionControl

Overrides:

clearOnce in class ActionSequence

setContext

public void setContext(IAnnotatedComponent parent,
 int index)

Specified by:

setContext in interface IAnnotatedComponent

Overrides:

setContext in class ActionSequence