Class ActionBase

java.lang.Object

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

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

All Implemented Interfaces:

Action, RoleStateChange, IAnnotatedComponent, IComponentExecutionControl

Direct Known Subclasses:

ActionAddToTargetMemory, ActionAdjustPortalTimer, ActionAppearance, ActionApplyEntityEffect, ActionAttack, ActionBeacon, ActionBlockHitInteraction, ActionChangeTargetRole, ActionClearEncounterBossBar, ActionClearEncounterWeather, ActionCombatAbility, ActionCrouch, ActionDelayDespawn, ActionDespawn, ActionDie, ActionDisplayName, ActionEntityHitInteraction, ActionFlockBeacon, ActionFlockJoin, ActionFlockLeave, ActionFlockSetTarget, ActionFlockState, ActionGrantReward, ActionIgnoreForAvoidance, ActionInventory, ActionLockOnInteractionTarget, ActionLog, ActionMakePath, ActionModelAttachment, ActionMount, ActionNothing, ActionNotify, ActionOpenBarterShop, ActionOpenShop, ActionOverrideAltitude, ActionOverrideAttitude, ActionParentState, ActionPlaceBlock, ActionPlayAnimation, ActionRandom, ActionRecomputePath, ActionReleaseTarget, ActionRemove, ActionResetBlockSensors, ActionResetInstructions, ActionResetPath, ActionResetSearchRays, ActionRole, ActionSequence, ActionSetAlarm, ActionSetBlockToPlace, ActionSetEncounterAudioState, ActionSetEncounterBossBar, ActionSetEncounterWeather, ActionSetFlag, ActionSetHealthRegen, ActionSetInteractable, ActionSetInvulnerable, ActionSetLeashPosition, ActionSetMarkedTarget, ActionSetStat, ActionSetTargetNPCInvulnerable, ActionSignalTaggedVolumes, ActionSignalWorldEvent, ActionSpawn, ActionStartEncounterMusic, ActionStartObjective, ActionState, ActionStopEncounterMusic, ActionStorePosition, ActionTest, ActionTimer, ActionToggleStateEvaluator, ActionTriggerSpawnBeacon, ActionTriggerSpawners, ActionWithDelay, DeferrableAction

public abstract class ActionBase
extends AnnotatedComponentBase
implements Action

Field Summary

Fields inherited from interface Action

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ActionBase(BuilderActionBase builderActionBase)

Method Summary

Modifier and Type	Method	Description
void	activate(ExecutionSupport executionSupport, InfoProvider infoProvider)	Called when the action is activated.
boolean	canExecute(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Store<EntityStore> store)	Test if an action can be executed
void	clearOnce()
void	deactivate(ExecutionSupport executionSupport, InfoProvider infoProvider)	Called when the action is deactivated.
boolean	execute(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Store<EntityStore> store)	Execute action
boolean	isActivated()	Checks if this action has been activated.
boolean	isTriggered()
boolean	processDelay(float dt)	Tick down the internal delay on this core component
void	setOnce()

Methods inherited from class AnnotatedComponentBase

getIndex, getInfo, getParent, setContext

Methods inherited from class Object

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

Methods inherited from interface Action

isBusy

Methods inherited from interface IAnnotatedComponent

getBreadCrumbs, getBreadCrumbs, getIndex, getInfo, getLabel, getParent, setContext

Methods inherited from interface RoleStateChange

loaded, motionControllerChanged, registerWithSupport, removed, spawned, teleported, unloaded

Constructor Details

ActionBase

public ActionBase(@Nonnull
 BuilderActionBase builderActionBase)

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

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

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

activate

public void activate(ExecutionSupport executionSupport,
 InfoProvider infoProvider)

Description copied from interface: Action

Called when the action is activated. In normal lists, this will be called for all actions in the list that can be executed. In blocking sequences, this will be called prior to beginning the first execution of the action in the current cycle.

Specified by:

activate in interface Action

Parameters:

executionSupport - The execution support

infoProvider - the InfoProvider from the parent sensor.

deactivate

public void deactivate(ExecutionSupport executionSupport,
 InfoProvider infoProvider)

Description copied from interface: Action

Called when the action is deactivated. In normal lists, this will be called if the action cannot be executed. In blocking sequences, this will be called when the execution of the action completes before moving to the next action.

Specified by:

deactivate in interface Action

Parameters:

executionSupport - The execution support

infoProvider - the InfoProvider from the parent sensor.

isActivated

public boolean isActivated()

Description copied from interface: Action

Checks if this action has been activated.

Specified by:

isActivated in interface Action

Returns:

true if activated, false if not.

isTriggered

public boolean isTriggered()

Specified by:

isTriggered in interface IComponentExecutionControl

clearOnce

public void clearOnce()

Specified by:

clearOnce in interface IComponentExecutionControl

setOnce

public void setOnce()

Specified by:

setOnce in interface IComponentExecutionControl

processDelay

public boolean processDelay(float dt)

Description copied from interface: IComponentExecutionControl

Tick down the internal delay on this core component

Specified by:

processDelay in interface IComponentExecutionControl

Parameters:

dt - the tick duration

Returns:

whether this component has finished processing its internal delay