Class ScopedPositionProvider

java.lang.Object

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

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

com.hypixel.hytale.server.npc.sensorinfo.ScopedPositionProvider

All Implemented Interfaces:

InfoProvider, IPositionProvider

public class ScopedPositionProvider
extends PositionProvider

A raw PositionProvider that also carries an optional associated entity, decoupling the position from the entity. Used by ForEach as the per-element provider so a scoped element can expose a computed position to position leaves while still surfacing the source entity to entity-target leaves and to isolation keying. Orientation (when the element carries one) is held by the inherited PositionProvider.

Constructor Summary

Constructors

Constructor	Description
ScopedPositionProvider()

Method Summary

Modifier and Type	Method	Description
void	clear()	Reset position provider so that hasPosition() will return false.
Ref<EntityStore>	getTarget()	Return target entity if sensor provides it currently.
void	setEntity(Ref<EntityStore> entity)

Methods inherited from class PositionProvider

clearOrientation, getPositionProvider, getX, getY, getZ, hasPosition, provideOrientation, providePosition, setOrientation, setTarget, setTarget, setTarget, setTarget

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

ScopedPositionProvider

public ScopedPositionProvider()

Method Details

setEntity

public void setEntity(@Nullable
 Ref<EntityStore> entity)

clear

public void clear()

Description copied from interface: IPositionProvider

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

Specified by:

clear in interface IPositionProvider

Overrides:

clear in class PositionProvider

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

Overrides:

getTarget in class PositionProvider

Returns:

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