Class BodyMotionWanderBase

java.lang.Object

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

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

com.hypixel.hytale.server.npc.corecomponents.BodyMotionBase

com.hypixel.hytale.server.npc.corecomponents.movement.BodyMotionWanderBase

All Implemented Interfaces:

BodyMotion, Motion, RoleStateChange, IAnnotatedComponent

Direct Known Subclasses:

BodyMotionWander, BodyMotionWanderInCircle, BodyMotionWanderInRect

public abstract class BodyMotionWanderBase
extends BodyMotionBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BodyMotionWanderBase.State

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DIRECTION_COUNT
static final HytaleLogger	LOGGER
static final double	MIN_DISTANCE_SHRINK
static final double	MIN_DISTANCE_SHRINK_SCALE
static final float	SEGMENT_ANGLE

Constructor Summary

Constructors

Constructor	Description
BodyMotionWanderBase(BuilderBodyMotionWanderBase builder, BuilderSupport builderSupport)

Method Summary

Modifier and Type	Method	Description
void	activate(Ref<EntityStore> ref, ExecutionSupport executionSupport, ComponentAccessor<EntityStore> componentAccessor)	Called to activate this motion
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
EnumSet<RelaxedConstraint>	getRelaxedConstraints()	Returns the set of movement constraints that this body motion has been configured to relax, or null for body motions that do not support constraint relaxation.
void	motionControllerChanged(Ref<EntityStore> ref, NPCEntity npcComponent, MotionController motionController, ComponentAccessor<EntityStore> componentAccessor)

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 BodyMotion

findWrappedBodyMotion, getDesiredTargetDistance, getDesiredTargetEntity, getSteeringMotion

Methods inherited from interface IAnnotatedComponent

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

Methods inherited from interface Motion

preComputeSteering

Methods inherited from interface RoleStateChange

loaded, registerWithSupport, removed, spawned, teleported, unloaded

Field Details

LOGGER

public static final HytaleLogger LOGGER

DIRECTION_COUNT

public static final int DIRECTION_COUNT

See Also:

• Constant Field Values

SEGMENT_ANGLE

public static final float SEGMENT_ANGLE

See Also:

• Constant Field Values

MIN_DISTANCE_SHRINK

public static final double MIN_DISTANCE_SHRINK

See Also:

• Constant Field Values

MIN_DISTANCE_SHRINK_SCALE

public static final double MIN_DISTANCE_SHRINK_SCALE

See Also:

• Constant Field Values

Constructor Details

BodyMotionWanderBase

public BodyMotionWanderBase(@Nonnull
 BuilderBodyMotionWanderBase builder,
 @Nonnull
 BuilderSupport builderSupport)

Method Details

getRelaxedConstraints

@Nullable
public EnumSet<RelaxedConstraint> getRelaxedConstraints()

Description copied from interface: BodyMotion

Returns the set of movement constraints that this body motion has been configured to relax, or null for body motions that do not support constraint relaxation.

Returns:

the relaxed constraint set from the motion's configuration, or null if not applicable

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

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

Parameters:

ref - The entity ref

executionSupport - The ExecutionSupport

componentAccessor - The component store for component access

motionControllerChanged

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

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.

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.