Class Instruction

java.lang.Object

com.hypixel.hytale.server.npc.instructions.Instruction

All Implemented Interfaces:

RoleStateChange, IAnnotatedComponent, IAnnotatedComponentCollection

Direct Known Subclasses:

InstructionRandomized

public class Instruction
extends Object
implements RoleStateChange, IAnnotatedComponentCollection

Field Summary

Fields

Modifier and Type	Field	Description
static final Instruction[]	EMPTY_ARRAY
static final HytaleLogger	LOGGER

Constructor Summary

Constructors

Constructor	Description
Instruction(BuilderInstruction builder, Sensor sensor, Instruction[] instructionList, BuilderSupport support)

Method Summary

Modifier and Type	Method	Description
void	clearOnce()
int	componentCount()	Returns the number of components aggregated
static Instruction	createRootInstruction(Instruction[] instructions, BuilderSupport support)	Generates a root instruction for use in a Role.
void	execute(Ref<EntityStore> ref, ExecutionSupport executionSupport, double dt, Store<EntityStore> store)
void	executeActions(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Store<EntityStore> store)
<T extends BodyMotion> T	findNearestPrecedingBodyMotion(Class<T> clazz)
BodyMotion	getBodyMotion()
IAnnotatedComponent	getComponent(int index)	Returns the annotated component at the given index, or null if the component at said index is not annotated
String	getDebugTag()
HeadMotion	getHeadMotion()
int	getIndex()
void	getInfo(ExecutionSupport executionSupport, ComponentInfo holder)	Populates the ComponentInfo holder with any relevant information relating to this particular component
String	getLabel()
IAnnotatedComponent	getParent()
Sensor	getSensor()
double	getWeight()
boolean	isContinueAfter()
void	loaded(ExecutionSupport executionSupport)
boolean	matches(Ref<EntityStore> ref, ExecutionSupport executionSupport, double dt, Store<EntityStore> store)
void	motionControllerChanged(Ref<EntityStore> ref, NPCEntity npcComponent, MotionController motionController, ComponentAccessor<EntityStore> componentAccessor)
void	notifyChildSensorMatch()
void	onCompleted(ExecutionSupport executionSupport)
void	onEndMotion()
void	onMatched(ExecutionSupport executionSupport)
void	registerWithSupport(ExecutionSupport executionSupport)
void	removed(ExecutionSupport executionSupport)
void	reset()
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 Object

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

Methods inherited from interface IAnnotatedComponent

getBreadCrumbs, getBreadCrumbs

Field Details

EMPTY_ARRAY

public static final Instruction[] EMPTY_ARRAY

LOGGER

public static final HytaleLogger LOGGER

Constructor Details

Instruction

public Instruction(@Nonnull
 BuilderInstruction builder,
 Sensor sensor,
 @Nullable
 Instruction[] instructionList,
 @Nonnull
 BuilderSupport support)

Method Details

getSensor

public Sensor getSensor()

getDebugTag

@Nullable
public String getDebugTag()

getWeight

public double getWeight()

isContinueAfter

public boolean isContinueAfter()

getBodyMotion

@Nullable
public BodyMotion getBodyMotion()

findNearestPrecedingBodyMotion

@Nullable
public <T extends BodyMotion> T findNearestPrecedingBodyMotion(@Nonnull
 Class<T> clazz)

getHeadMotion

@Nullable
public HeadMotion getHeadMotion()

registerWithSupport

public void registerWithSupport(ExecutionSupport executionSupport)

Specified by:

registerWithSupport in interface RoleStateChange

motionControllerChanged

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

Specified by:

motionControllerChanged in interface RoleStateChange

loaded

public void loaded(ExecutionSupport executionSupport)

Specified by:

loaded in interface RoleStateChange

spawned

public void spawned(ExecutionSupport executionSupport)

Specified by:

spawned in interface RoleStateChange

unloaded

public void unloaded(ExecutionSupport executionSupport)

Specified by:

unloaded in interface RoleStateChange

removed

public void removed(ExecutionSupport executionSupport)

Specified by:

removed in interface RoleStateChange

teleported

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

Specified by:

teleported in interface RoleStateChange

componentCount

public int componentCount()

Description copied from interface: IAnnotatedComponentCollection

Returns the number of components aggregated

Specified by:

componentCount in interface IAnnotatedComponentCollection

Returns:

the number of components aggregated

getComponent

public IAnnotatedComponent getComponent(int index)

Description copied from interface: IAnnotatedComponentCollection

Returns the annotated component at the given index, or null if the component at said index is not annotated

Specified by:

getComponent in interface IAnnotatedComponentCollection

Parameters:

index - the index to fetch

Returns:

the annotated component, or null if the component at the index is not annotated

getInfo

public void getInfo(ExecutionSupport executionSupport,
 @Nonnull
 ComponentInfo holder)

Description copied from interface: IAnnotatedComponent

Populates the ComponentInfo holder with any relevant information relating to this particular component

Specified by:

getInfo in interface IAnnotatedComponent

Parameters:

executionSupport - per-execution context

holder - the ComponentInfo instance to populate

getParent

public IAnnotatedComponent getParent()

Specified by:

getParent in interface IAnnotatedComponent

getIndex

public int getIndex()

Specified by:

getIndex in interface IAnnotatedComponent

getLabel

@Nonnull
public String getLabel()

Specified by:

getLabel in interface IAnnotatedComponent

setContext

public void setContext(IAnnotatedComponent parent,
 int index)

Specified by:

setContext in interface IAnnotatedComponent

matches

public boolean matches(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 double dt,
 @Nonnull
 Store<EntityStore> store)

executeActions

public void executeActions(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 InfoProvider sensorInfo,
 double dt,
 @Nonnull
 Store<EntityStore> store)

execute

public void execute(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 double dt,
 @Nonnull
 Store<EntityStore> store)

clearOnce

public void clearOnce()

onEndMotion

public void onEndMotion()

onMatched

public void onMatched(@Nonnull
 ExecutionSupport executionSupport)

onCompleted

public void onCompleted(@Nonnull
 ExecutionSupport executionSupport)

notifyChildSensorMatch

public void notifyChildSensorMatch()

reset

public void reset()

createRootInstruction

@Nonnull
public static Instruction createRootInstruction(Instruction[] instructions,
 @Nonnull
 BuilderSupport support)

Generates a root instruction for use in a Role.

Parameters:

instructions - List of instructions used by the Role.

support - Builder support.

Returns:

The generated root instruction.