Class MotionControllerWalk

java.lang.Object

com.hypixel.hytale.server.npc.movement.controllers.MotionControllerBase

com.hypixel.hytale.server.npc.movement.controllers.MotionControllerWalk

All Implemented Interfaces:

MotionController, DebugSupport.DebugFlagsChangeListener

public class MotionControllerWalk
extends MotionControllerBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MotionControllerWalk.AscentAnimationType
static enum	MotionControllerWalk.DescentAnimationType

Nested classes/interfaces inherited from interface MotionController

MotionController.VerticalRange

Field Summary

Fields

Modifier and Type	Field	Description
static final double	CLIMB_FORWARD_DISTANCE
static final double	CLIMB_FORWARD_DISTANCE_SQUARED
static final double	EDGE_MARGIN_BBOX_FACTOR
static final double	JUMP_FORWARD_DISTANCE
static final double	MIN_SAFETY_DISTANCE
static final double	MIN_SEPARATION_STEERING
static final double	ONE_PLUS_THRESHOLD
static final Set<MovementMode>	SUPPORTED_MOVEMENT_MODES
static final String	TYPE

Fields inherited from class MotionControllerBase

BISECT_DIST, DEBUG_APPLIED_FORCES, DEFAULT_BLOCK_DRAG, DOT_PRODUCT_EPSILON, FILTER_COEFFICIENT, FORCE_SCALE

Constructor Summary

Constructors

Constructor	Description
MotionControllerWalk(BuilderMotionControllerWalk builder, BuilderSupport builderSupport)

Method Summary

Modifier and Type	Method	Description
boolean	canRestAtPlace()
boolean	canSteer(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)
String	canSteerFailReason(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)	If MotionController.canSteer(Ref, ComponentAccessor) returns false, this method can be called to get a human-readable reason for why the motion controller cannot steer.
void	constrainRotations(Role role, TransformComponent transform)
boolean	estimateVelocity(Steering steering, org.joml.Vector3d velocityOut)
double	getCurrentMaxBodyRotationSpeed()
double	getCurrentSpeed()
double	getCurrentTurnRadius()
Set<MovementMode>	getDefaultSpawnMovementModes()
double	getDesiredAltitudeWeight()
MotionController.VerticalRange	getDesiredVerticalRange(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)
double	getHeightOverGround()
float	getMaxClimbAngle()
double	getMaxClimbHeight()	Maximum vertical distance the controller can climb in a single step (e.g. on some block).
double	getMaxDropHeight()	Maximum vertical distance the controller can drop in a single step (e.g. off a ledge).
double	getMaximumSpeed()
float	getMaxSinkAngle()
Set<MovementMode>	getSupportedMovementModes()
String	getType()
double	getWanderVerticalMovementRatio()
boolean	inAir()
boolean	inWater()
boolean	is2D()
boolean	isFastMotionKind(double speed)
boolean	isInProgress()
boolean	onGround()
void	postReadPosition(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)
double	probeMove(Ref<EntityStore> ref, ProbeMoveData probeMoveData, ComponentAccessor<EntityStore> componentAccessor)
void	setMotionKind(MotionKind motionKind)
void	setVelocity(org.joml.Vector3dc velocity, VelocityConfig velocityConfig, boolean ignoreDamping)
void	setVelocity(org.joml.Vector3dc velocity, VelocityConfig velocityConfig, boolean ignoreDamping, float preMultiplier)
void	spawned()
boolean	standingOnBlockOfType(int blockSet)
boolean	touchesWater(boolean defaultValue, ComponentAccessor<EntityStore> componentAccessor)	Determines whether the entity associated with this motion controller is touching water.
static int	translateToAccessiblePosition(org.joml.Vector3d position, double minYValue, double maxYValue, ComponentAccessor<EntityStore> componentAccessor)	Find position not in solid block by translating position up or down
boolean	translateToAccessiblePosition(org.joml.Vector3d position, Box boundingBox, double minYValue, double maxYValue, ComponentAccessor<EntityStore> componentAccessor)
void	updateModelParameters(Ref<EntityStore> ref, Model model, Box boundingBox, ComponentAccessor<EntityStore> componentAccessor)

Methods inherited from class MotionControllerBase

activate, addVelocity, applyRailStep, beforeInstructionMotion, beforeInstructionSensorsAndActions, bisect, bisect, clearBlendHeading, clearExternalForces, clearExternalVelocity, clearRequirePreciseMovement, deactivate, enableHeadingBlending, enableHeadingBlending, getCollisionBoundingBox, getCombinedExternalVelocityLength, getComponentSelector, getEpsilonAngle, getEpsilonSpeed, getExternalVelocity, getGravity, getInvalidOverlapMaterials, getMotionKind, getNavState, getPitch, getPlanarComponentSelector, getRelaxedConstraints, getRole, getRoll, getTargetDeltaSquared, getThrottleDuration, getWorldAntiNormal, getWorldNormal, getYaw, isAvoidingBlockDamage, isForcePushed, isForceRecomputePath, isHorizontalIdle, isMovementBlocked, isObstructed, isProcessTriggersHasMoved, isRequiresPreciseMovement, isValidPosition, isValidPosition, moveEntity, onDebugFlagsChanged, preScaleKnockback, probeMove, processTriggers, requirePreciseMovement, resetNavState, resetObstructedFlags, setComponentSelector, setDebugEntityId, setEnableBlockDamage, setEnableTriggers, setForceRecomputePath, setGravity, setHeadPitchAngleRange, setInertia, setKnockbackScale, setNavState, setRelaxedMoveConstraints, setRole, setUseFixedKnockback, steer, steer0, updateMovementState, updatePhysicsValues, waypointDistance, waypointDistance, waypointDistanceSquared, waypointDistanceSquared, willReceiveBlockDamage

Methods inherited from class Object

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

Methods inherited from interface MotionController

addVelocity, clearOverrides, getSquaredDistance, matchesType

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

SUPPORTED_MOVEMENT_MODES

public static final Set<MovementMode> SUPPORTED_MOVEMENT_MODES

CLIMB_FORWARD_DISTANCE

public static final double CLIMB_FORWARD_DISTANCE

See Also:

• Constant Field Values

CLIMB_FORWARD_DISTANCE_SQUARED

public static final double CLIMB_FORWARD_DISTANCE_SQUARED

See Also:

• Constant Field Values

JUMP_FORWARD_DISTANCE

public static final double JUMP_FORWARD_DISTANCE

See Also:

• Constant Field Values

ONE_PLUS_THRESHOLD

public static final double ONE_PLUS_THRESHOLD

See Also:

• Constant Field Values

MIN_SAFETY_DISTANCE

public static final double MIN_SAFETY_DISTANCE

See Also:

• Constant Field Values

EDGE_MARGIN_BBOX_FACTOR

public static final double EDGE_MARGIN_BBOX_FACTOR

See Also:

• Constant Field Values

MIN_SEPARATION_STEERING

public static final double MIN_SEPARATION_STEERING

See Also:

• Constant Field Values

Constructor Details

MotionControllerWalk

public MotionControllerWalk(@Nonnull
 BuilderMotionControllerWalk builder,
 @Nonnull
 BuilderSupport builderSupport)

Method Details

getType

@Nonnull
public String getType()

getSupportedMovementModes

@Nonnull
public Set<MovementMode> getSupportedMovementModes()

getDefaultSpawnMovementModes

@Nonnull
public Set<MovementMode> getDefaultSpawnMovementModes()

spawned

public void spawned()

getWanderVerticalMovementRatio

public double getWanderVerticalMovementRatio()

getDesiredVerticalRange

@Nonnull
public MotionController.VerticalRange getDesiredVerticalRange(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

isFastMotionKind

public boolean isFastMotionKind(double speed)

isInProgress

public boolean isInProgress()

Specified by:

isInProgress in interface MotionController

Overrides:

isInProgress in class MotionControllerBase

canSteer

public boolean canSteer(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Specified by:

canSteer in interface MotionController

Overrides:

canSteer in class MotionControllerBase

canSteerFailReason

@Nullable
public String canSteerFailReason(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from interface: MotionController

If MotionController.canSteer(Ref, ComponentAccessor) returns false, this method can be called to get a human-readable reason for why the motion controller cannot steer.

Specified by:

canSteerFailReason in interface MotionController

Overrides:

canSteerFailReason in class MotionControllerBase

Parameters:

ref - NPC entity reference

componentAccessor - Accessor to get components of the NPC entity

Returns:

A human-readable reason for why the motion controller cannot steer, or null if the motion controller can steer

updateModelParameters

public void updateModelParameters(Ref<EntityStore> ref,
 Model model,
 @Nonnull
 Box boundingBox,
 ComponentAccessor<EntityStore> componentAccessor)

Specified by:

updateModelParameters in interface MotionController

Overrides:

updateModelParameters in class MotionControllerBase

constrainRotations

public void constrainRotations(Role role,
 @Nonnull
 TransformComponent transform)

setVelocity

public void setVelocity(@Nonnull
 org.joml.Vector3dc velocity,
 VelocityConfig velocityConfig,
 boolean ignoreDamping)

Specified by:

setVelocity in interface MotionController

Overrides:

setVelocity in class MotionControllerBase

setVelocity

public void setVelocity(@Nonnull
 org.joml.Vector3dc velocity,
 VelocityConfig velocityConfig,
 boolean ignoreDamping,
 float preMultiplier)

Specified by:

setVelocity in interface MotionController

Overrides:

setVelocity in class MotionControllerBase

inAir

public boolean inAir()

onGround

public boolean onGround()

standingOnBlockOfType

public boolean standingOnBlockOfType(int blockSet)

Specified by:

standingOnBlockOfType in interface MotionController

Overrides:

standingOnBlockOfType in class MotionControllerBase

inWater

public boolean inWater()

touchesWater

public boolean touchesWater(boolean defaultValue,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from class: MotionControllerBase

Determines whether the entity associated with this motion controller is touching water.

Overrides:

touchesWater in class MotionControllerBase

Parameters:

defaultValue - The default value to return if the chunk is not loaded.

componentAccessor - The ComponentAccessor<EntityStore> for component access.

Returns:

true if the entity is touching water, false otherwise.

getCurrentSpeed

public double getCurrentSpeed()

getCurrentTurnRadius

public double getCurrentTurnRadius()

getMaxClimbAngle

public float getMaxClimbAngle()

getMaxSinkAngle

public float getMaxSinkAngle()

getMaxClimbHeight

public double getMaxClimbHeight()

Description copied from interface: MotionController

Maximum vertical distance the controller can climb in a single step (e.g. on some block). Default 0 for controllers without a climb concept; overridden by ground-based controllers like MotionControllerWalk.

getMaxDropHeight

public double getMaxDropHeight()

Description copied from interface: MotionController

Maximum vertical distance the controller can drop in a single step (e.g. off a ledge). Default 0 for controllers without a drop concept; overridden by ground-based controllers like MotionControllerWalk.

getMaximumSpeed

public double getMaximumSpeed()

is2D

public boolean is2D()

canRestAtPlace

public boolean canRestAtPlace()

getDesiredAltitudeWeight

public double getDesiredAltitudeWeight()

getHeightOverGround

public double getHeightOverGround()

estimateVelocity

public boolean estimateVelocity(@Nonnull
 Steering steering,
 @Nonnull
 org.joml.Vector3d velocityOut)

setMotionKind

public void setMotionKind(MotionKind motionKind)

Overrides:

setMotionKind in class MotionControllerBase

postReadPosition

public void postReadPosition(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Overrides:

postReadPosition in class MotionControllerBase

translateToAccessiblePosition

public boolean translateToAccessiblePosition(@Nonnull
 org.joml.Vector3d position,
 @Nullable
 Box boundingBox,
 double minYValue,
 double maxYValue,
 ComponentAccessor<EntityStore> componentAccessor)

Specified by:

translateToAccessiblePosition in interface MotionController

Overrides:

translateToAccessiblePosition in class MotionControllerBase

translateToAccessiblePosition

public static int translateToAccessiblePosition(@Nonnull
 org.joml.Vector3d position,
 double minYValue,
 double maxYValue,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Find position not in solid block by translating position up or down

Parameters:

position - Initial position which will be updated with result position on success

minYValue - Minimum allowed y position

maxYValue - Maximum allowed y position

componentAccessor - The ComponentAccessor<EntityStore> for component access.

Returns:

-1 in case of error, 0 in case no position in range could be found or 1 in case of success (position will be updated then)

probeMove

public double probeMove(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ProbeMoveData probeMoveData,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

getCurrentMaxBodyRotationSpeed

public double getCurrentMaxBodyRotationSpeed()