Class RailStepResult

java.lang.Object

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

public final class RailStepResult
extends Object

Per-tick result carrier for MotionController.applyRailStep(Ref, Role, Vector3dc, RailStepConfig, RailStepResult, ComponentAccessor).

Allocated once by the BodyMotion and reused across ticks. reset() clears the scalar fields and resets the hit counts to 0 without releasing the underlying storage; hit entries are pooled and reused on subsequent ticks. The backing arrays only grow when a tick reports more hits than any previous tick did.

Typical access pattern for callers:

result.reset();
// ... motionController.applyRailStep(..., result, ...);
for (int i = 0; i < result.getPassThroughCount(); i++) {
    var hit = result.getPassThrough(i);
    // read hit.blockX, hit.collisionPoint, ...
}

Field Summary

Fields

Modifier and Type	Field	Description
double	appliedFraction	Fraction of the requested delta actually applied to the entity's position, in [0, 1].
boolean	hitEntity	true when the step was clamped short of the requested delta by an entity collision while RailStepConfig.stopOnEntityHit was true.
boolean	obstructed	true when the step was clamped short of the requested delta by a non-ignored block collision.

Constructor Summary

Constructors

Constructor	Description
RailStepResult()

Method Summary

Modifier and Type	Method	Description
EntityHit	getEntityHit(int i)
int	getEntityHitCount()
BlockHit	getPassThrough(int i)
int	getPassThroughCount()
EntityHit	nextEntityHit()	Return a pooled EntityHit slot and bump the count.
BlockHit	nextPassThrough()	Return a pooled BlockHit slot and bump the count.
void	reset()	Clear the previous tick's data.

Methods inherited from class Object

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

Field Details

obstructed

public boolean obstructed

true when the step was clamped short of the requested delta by a non-ignored block collision.

hitEntity

public boolean hitEntity

true when the step was clamped short of the requested delta by an entity collision while RailStepConfig.stopOnEntityHit was true.

appliedFraction

public double appliedFraction

Fraction of the requested delta actually applied to the entity's position, in [0, 1].

Constructor Details

RailStepResult

public RailStepResult()

Method Details

reset

public void reset()

Clear the previous tick's data. Resets scalar fields and hit counts; the pooled hit instances and their backing arrays are retained.

getPassThroughCount

public int getPassThroughCount()

getPassThrough

@Nonnull
public BlockHit getPassThrough(int i)

nextPassThrough

@Nonnull
public BlockHit nextPassThrough()

Return a pooled BlockHit slot and bump the count. The caller is expected to overwrite the returned instance via BlockHit.assign(int, int, int, int, Vector3dc, Vector3dc, double).

getEntityHitCount

public int getEntityHitCount()

getEntityHit

@Nonnull
public EntityHit getEntityHit(int i)

nextEntityHit

@Nonnull
public EntityHit nextEntityHit()

Return a pooled EntityHit slot and bump the count. The caller is expected to overwrite the returned instance via EntityHit.assign(Ref, boolean, Vector3dc, Vector3dc, double).