Class ActionFlockBeacon

java.lang.Object

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

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

com.hypixel.hytale.server.flock.corecomponents.ActionFlockBeacon

All Implemented Interfaces:

Action, RoleStateChange, IAnnotatedComponent, IComponentExecutionControl

public class ActionFlockBeacon
extends ActionBase

The beacon action that entities can use to send out messages to members in the flock. By default, the message will send to everyone in the flock including yourself except when the send to leader only flag is true or the send to self flag is false

Field Summary

Fields inherited from interface Action

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ActionFlockBeacon(BuilderActionFlockBeacon builderActionFlockBeacon, BuilderSupport builderSupport)

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
boolean	execute(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Store<EntityStore> store)	Execute action

Methods inherited from class ActionBase

activate, clearOnce, deactivate, isActivated, isTriggered, processDelay, 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

ActionFlockBeacon

public ActionFlockBeacon(@Nonnull
 BuilderActionFlockBeacon builderActionFlockBeacon,
 @Nonnull
 BuilderSupport builderSupport)

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 ActionBase

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 ActionBase

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