Class MotionSequence<T extends Motion>

java.lang.Object

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

com.hypixel.hytale.server.npc.corecomponents.MotionBase

com.hypixel.hytale.server.npc.corecomponents.utility.MotionSequence<T>

All Implemented Interfaces:

Motion, RoleStateChange, IAnnotatedComponent, IAnnotatedComponentCollection

Direct Known Subclasses:

BodyMotionSequence, HeadMotionSequence

public abstract class MotionSequence<T extends Motion>
extends MotionBase
implements IAnnotatedComponentCollection

Constructor Summary

Constructors

Constructor	Description
MotionSequence(BuilderMotionSequence<T> builder, T[] steps)

Method Summary

Modifier and Type	Method	Description
void	activate(Ref<EntityStore> ref, ExecutionSupport executionSupport, ComponentAccessor<EntityStore> componentAccessor)	Called to activate this motion
int	componentCount()	Returns the number of components aggregated
boolean	computeSteering(Ref<EntityStore> ref, ExecutionSupport executionSupport, InfoProvider sensorInfo, double dt, Steering desiredSteering, ComponentAccessor<EntityStore> componentAccessor)	Calculate desired steering for MotionController.
void	deactivate(Ref<EntityStore> ref, ExecutionSupport executionSupport, ComponentAccessor<EntityStore> componentAccessor)	Called to deactivate this motion
IAnnotatedComponent	getComponent(int index)	Returns the annotated component at the given index, or null if the component at said index is not annotated
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	restart()
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 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

Methods inherited from interface Motion

preComputeSteering

Constructor Details

MotionSequence

public MotionSequence(@Nonnull
 BuilderMotionSequence<T> builder,
 T[] steps)

Method Details

activate

public void activate(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from interface: Motion

Called to activate this motion

Specified by:

activate in interface Motion

Parameters:

ref - The entity ref of the NPC

executionSupport - The ExecutionSupport

componentAccessor - The entity store for component access

deactivate

public void deactivate(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from interface: Motion

Called to deactivate this motion

Specified by:

deactivate in interface Motion

Parameters:

ref - The entity ref

executionSupport - The ExecutionSupport

componentAccessor - The component store for component access

computeSteering

public boolean computeSteering(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nullable
 InfoProvider sensorInfo,
 double dt,
 @Nonnull
 Steering desiredSteering,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from interface: Motion

Calculate desired steering for MotionController.

Specified by:

computeSteering in interface Motion

Parameters:

ref - The entity ref

executionSupport - The ExecutionSupport

sensorInfo - SensorInfo with PositionProvider, PathProvider, etc. if required

dt - The interval in seconds for this calculation

desiredSteering - The computed steering force for the MotionController

componentAccessor - The entity store

Returns:

false when the end condition has been reached, true if must be called again to reach end condition or is infinite.

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

setContext

public void setContext(IAnnotatedComponent parent,
 int index)

Specified by:

setContext in interface IAnnotatedComponent

Overrides:

setContext in class AnnotatedComponentBase

restart

public void restart()