Class PositionProvider

java.lang.Object

com.hypixel.hytale.server.npc.sensorinfo.InfoProviderBase

com.hypixel.hytale.server.npc.sensorinfo.PositionProvider

All Implemented Interfaces:

InfoProvider, IPositionProvider

Direct Known Subclasses:

CachedPositionProvider, EntityPositionProvider, ScopedPositionProvider

public class PositionProvider
extends InfoProviderBase
implements IPositionProvider

Helper class to implement a position provider for a plain position.

Constructor Summary

Constructors

Constructor	Description
PositionProvider()
PositionProvider(ParameterProvider parameterProvider)
PositionProvider(ParameterProvider parameterProvider, ExtraInfoProvider... providers)

Method Summary

Modifier and Type	Method	Description
void	clear()	Reset position provider so that hasPosition() will return false.
void	clearOrientation()
IPositionProvider	getPositionProvider()	We provide direct access to the position provider as it's the most frequently used provider and is used in a very large number of actions and motions.
Ref<EntityStore>	getTarget()	Return target entity if sensor provides it currently.
double	getX()	Return x coordinate of available position.
double	getY()	Return y coordinate of available position.
double	getZ()	Return z coordinate of available position.
boolean	hasPosition()	Test if PositionProvider does return a position currently.
boolean	provideOrientation(Rotation3f out)	Writes the orientation of the current (primary) position into out, when one is available.
boolean	providePosition(org.joml.Vector3d result)	Test and return sensor positional result if available.
void	setOrientation(Rotation3fc orientation)
void	setTarget(double x, double y, double z)
Ref<EntityStore>	setTarget(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)
Ref<EntityStore>	setTarget(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor, boolean includeDead)
void	setTarget(org.joml.Vector3d pos)

Methods inherited from class InfoProviderBase

getExtraInfo, getParameterProvider, getPassedExtraInfo, passExtraInfo

Methods inherited from class Object

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

Constructor Details

PositionProvider

public PositionProvider()

PositionProvider

public PositionProvider(ParameterProvider parameterProvider)

PositionProvider

public PositionProvider(ParameterProvider parameterProvider,
 ExtraInfoProvider... providers)

Method Details

clear

public void clear()

Description copied from interface: IPositionProvider

Reset position provider so that hasPosition() will return false.

Specified by:

clear in interface IPositionProvider

setTarget

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

setTarget

@Nullable
public Ref<EntityStore> setTarget(@Nullable
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor,
 boolean includeDead)

setTarget

public void setTarget(@Nonnull
 org.joml.Vector3d pos)

setTarget

public void setTarget(double x,
 double y,
 double z)

providePosition

public boolean providePosition(@Nonnull
 org.joml.Vector3d result)

Description copied from interface: IPositionProvider

Test and return sensor positional result if available.

Specified by:

providePosition in interface IPositionProvider

Parameters:

result - Vector3d receiving position information if available

Returns:

True if position is available and result was updated, false if no position available

getX

public double getX()

Description copied from interface: IPositionProvider

Return x coordinate of available position.

Specified by:

getX in interface IPositionProvider

Returns:

Coordinate if position available else result is undefined.

getY

public double getY()

Description copied from interface: IPositionProvider

Return y coordinate of available position.

Specified by:

getY in interface IPositionProvider

Returns:

Coordinate if position available else result is undefined.

getZ

public double getZ()

Description copied from interface: IPositionProvider

Return z coordinate of available position.

Specified by:

getZ in interface IPositionProvider

Returns:

Coordinate if position available else result is undefined.

getPositionProvider

@Nonnull
public IPositionProvider getPositionProvider()

Description copied from interface: InfoProvider

We provide direct access to the position provider as it's the most frequently used provider and is used in a very large number of actions and motions.

Specified by:

getPositionProvider in interface InfoProvider

Returns:

the position provider.

hasPosition

public boolean hasPosition()

Description copied from interface: IPositionProvider

Test if PositionProvider does return a position currently.

Specified by:

hasPosition in interface InfoProvider

Specified by:

hasPosition in interface IPositionProvider

Returns:

if true providePosition and getX/Y/Z will return positional result of sensor

getTarget

@Nullable
public Ref<EntityStore> getTarget()

Description copied from interface: IPositionProvider

Return target entity if sensor provides it currently.

A sensor might return a valid position but return a null value here if this position does not correlate to an entity.

Specified by:

getTarget in interface IPositionProvider

Returns:

entity ref if sensor is matching and result refers to an entity, else null.

provideOrientation

public boolean provideOrientation(@Nonnull
 Rotation3f out)

Description copied from interface: IPositionProvider

Writes the orientation of the current (primary) position into out, when one is available.

Specified by:

provideOrientation in interface IPositionProvider

Returns:

true if an orientation was written, false otherwise (in which case out is left untouched).

setOrientation

public void setOrientation(@Nonnull
 Rotation3fc orientation)

clearOrientation

public void clearOrientation()