Class PositionCache

java.lang.Object

com.hypixel.hytale.server.npc.role.support.PositionCache

All Implemented Interfaces:

Component<EntityStore>, Cloneable

public class PositionCache
extends Object
implements Component<EntityStore>

PositionCache is updated at least once per tick and caches information which might be accessed by multiple sensors like entity and player lists.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PositionCache.RayPredicate<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FUNCTION_CAN_BE_ONLY_CALLED_WHILE_CONFIGURING_POSITION_CACHE
static final BiPredicate<Ref<EntityStore>, ComponentAccessor<EntityStore>>	IS_VALID_NPC
static final BiPredicate<Ref<EntityStore>, ComponentAccessor<EntityStore>>	IS_VALID_PLAYER
static final double	MIN_LOS_BLOCKING_DISTANCE_SQUARED
static final float	POSITION_CACHE_TTL_SECONDS

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
PositionCache()
PositionCache(RoleStats roleStats)

Method Summary

Modifier and Type	Method	Description
void	addExternalPositionCacheRegistration(Consumer<ExecutionSupport> registration)	Should be used to register methods by which external systems and components want to update aspects of the PositionCache that are only modifiable during initialisation (e.g. distance ranges).
void	clear(double tickTime)
Component<EntityStore>	clone()
boolean	couldBreatheCached()
<S,T> int	countEntitiesInRange(double minRange, double maxRange, boolean findPlayers, QuadPredicate<S, Ref<EntityStore>, T, ComponentAccessor<EntityStore>> filter, S s, T t, ComponentAccessor<EntityStore> componentAccessor)
void	finalizeConfiguration()
<T,U> void	forEachEntityInAvoidanceRange(Set<Ref<EntityStore>> ignoredEntitiesForAvoidance, QuadConsumer<Ref<EntityStore>, T, U, CommandBuffer<EntityStore>> consumer, T t, U u, CommandBuffer<EntityStore> commandBuffer)
<T> void	forEachEntityInAvoidanceRange(Set<Ref<EntityStore>> ignoredEntitiesForAvoidance, TriConsumer<Ref<EntityStore>, T, CommandBuffer<EntityStore>> consumer, T t, CommandBuffer<EntityStore> commandBuffer)
<T,U,V,R> void	forEachNPCUnordered(double maxDistance, QuadPredicate<Ref<EntityStore>, T, U, ComponentAccessor<EntityStore>> predicate, QuadConsumer<Ref<EntityStore>, T, V, R> consumer, T t, U u, V v, R r, ComponentAccessor<EntityStore> componentAccessor)
<T,U,V> void	forEachPlayer(DoubleQuadObjectConsumer<Ref<EntityStore>, T, U, V> consumer, T t, U u, V v, double d, ComponentAccessor<EntityStore> componentAccessor)
static PositionCache	get(Ref<EntityStore> ref, ComponentAccessor<EntityStore> accessor)
<S> Ref<EntityStore>	getClosestDroppedItemInRange(Ref<EntityStore> ref, double minRange, double maxRange, TriPredicate<S, Ref<EntityStore>, ComponentAccessor<EntityStore>> filter, S s, ComponentAccessor<EntityStore> componentAccessor)
Ref<EntityStore>	getClosestNPCInRange(double minRange, double maxRange, Predicate<Ref<EntityStore>> filter, ComponentAccessor<EntityStore> componentAccessor)
Ref<EntityStore>	getClosestPlayerInRange(double minRange, double maxRange, ComponentAccessor<EntityStore> componentAccessor)
Ref<EntityStore>	getClosestPlayerInRange(double minRange, double maxRange, Predicate<Ref<EntityStore>> filter, ComponentAccessor<EntityStore> componentAccessor)
static ComponentType<EntityStore, PositionCache>	getComponentType()
List<Ref<EntityStore>>	getDroppedItemList()
List<Consumer<ExecutionSupport>>	getExternalRegistrations()
double	getMaxDroppedItemDistance()
int	getMaxSpawnBeaconDistance()
double	getMaxSpawnMarkerDistance()
EntityList	getNpcs()
EntityList	getPlayers()
int	getRoleIndex()
RoleStats	getRoleStats()
List<Ref<EntityStore>>	getSpawnBeaconList()
List<Ref<EntityStore>>	getSpawnMarkerList()
boolean	hasInverseLineOfSight(Ref<EntityStore> ref, Ref<EntityStore> targetRef, ComponentAccessor<EntityStore> componentAccessor)
boolean	hasLineOfSight(Ref<EntityStore> ref, Ref<EntityStore> targetRef, ComponentAccessor<EntityStore> componentAccessor)
boolean	isBenchmarking()
<S> boolean	isEntityCountInRange(double minRange, double maxRange, int minCount, int maxCount, boolean findPlayers, int roleIndex, QuadPredicate<S, Ref<EntityStore>, Integer, ComponentAccessor<EntityStore>> filter, S s, ComponentAccessor<EntityStore> componentAccessor)
boolean	isFriendlyBlockingLineOfSight(Ref<EntityStore> ref, Ref<EntityStore> targetRef, ComponentAccessor<EntityStore> componentAccessor)
<S,T> void	processEntitiesInRange(Ref<EntityStore> ref, EntityList entities, double minRange, double maxRange, boolean useProjectedDistance, Ref<EntityStore> ignoredEntityReference, ExecutionSupport executionSupport, QuadPredicate<S, Ref<EntityStore>, ExecutionSupport, T> filter, S s, T t, ComponentAccessor<EntityStore> componentAccessor)
<S,T> void	processNPCsInRange(Ref<EntityStore> ref, double minRange, double maxRange, boolean useProjectedDistance, Ref<EntityStore> ignoredEntityReference, ExecutionSupport executionSupport, QuadPredicate<S, Ref<EntityStore>, ExecutionSupport, T> filter, S s, T t, ComponentAccessor<EntityStore> componentAccessor)
<S,T> void	processPlayersInRange(Ref<EntityStore> ref, double minRange, double maxRange, boolean useProjectedDistance, Ref<EntityStore> ignoredEntityReference, ExecutionSupport executionSupport, QuadPredicate<S, Ref<EntityStore>, ExecutionSupport, T> filter, S s, T t, ComponentAccessor<EntityStore> componentAccessor)
void	requireDroppedItemDistance(double value)
void	requireEntityDistanceAvoidance(double v)
void	requireEntityDistanceSorted(double v)
void	requireEntityDistanceUnsorted(double v)
void	requirePlayerDistanceAvoidance(double v)
void	requirePlayerDistanceSorted(double v)
void	requirePlayerDistanceUnsorted(double v)
void	requireSpawnBeaconDistance(int value)
void	requireSpawnMarkerDistance(double value)
void	reset(boolean isConfiguring)
void	resetPositionCacheNextUpdate()
void	setBenchmarking(boolean benchmarking)
void	setCouldBreathe(boolean couldBreathe)
void	setOpaqueBlockSet(int blockSet)
void	setRoleIndex(int roleIndex)	Set the owning Role's index for benchmark counter attribution.
boolean	tickPositionCacheNextUpdate(float dt)

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Field Details

IS_VALID_PLAYER

public static final BiPredicate<Ref<EntityStore>, ComponentAccessor<EntityStore>> IS_VALID_PLAYER

IS_VALID_NPC

public static final BiPredicate<Ref<EntityStore>, ComponentAccessor<EntityStore>> IS_VALID_NPC

MIN_LOS_BLOCKING_DISTANCE_SQUARED

public static final double MIN_LOS_BLOCKING_DISTANCE_SQUARED

See Also:

• Constant Field Values

FUNCTION_CAN_BE_ONLY_CALLED_WHILE_CONFIGURING_POSITION_CACHE

public static final String FUNCTION_CAN_BE_ONLY_CALLED_WHILE_CONFIGURING_POSITION_CACHE

See Also:

• Constant Field Values

POSITION_CACHE_TTL_SECONDS

public static final float POSITION_CACHE_TTL_SECONDS

See Also:

• Constant Field Values

Constructor Details

PositionCache

public PositionCache(@Nullable
 RoleStats roleStats)

PositionCache

public PositionCache()

Method Details

getComponentType

@Nonnull
public static ComponentType<EntityStore, PositionCache> getComponentType()

get

@Nonnull
public static PositionCache get(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> accessor)

setRoleIndex

public void setRoleIndex(int roleIndex)

Set the owning Role's index for benchmark counter attribution.

getRoleIndex

public int getRoleIndex()

getRoleStats

@Nullable
public RoleStats getRoleStats()

isBenchmarking

public boolean isBenchmarking()

setBenchmarking

public void setBenchmarking(boolean benchmarking)

setCouldBreathe

public void setCouldBreathe(boolean couldBreathe)

getPlayers

public EntityList getPlayers()

getNpcs

public EntityList getNpcs()

tickPositionCacheNextUpdate

public boolean tickPositionCacheNextUpdate(float dt)

resetPositionCacheNextUpdate

public void resetPositionCacheNextUpdate()

getMaxDroppedItemDistance

public double getMaxDroppedItemDistance()

getMaxSpawnMarkerDistance

public double getMaxSpawnMarkerDistance()

getMaxSpawnBeaconDistance

public int getMaxSpawnBeaconDistance()

addExternalPositionCacheRegistration

public void addExternalPositionCacheRegistration(Consumer<ExecutionSupport> registration)

Should be used to register methods by which external systems and components want to update aspects of the PositionCache that are only modifiable during initialisation (e.g. distance ranges).

Parameters:

registration - the registration method.

getExternalRegistrations

@Nonnull
public List<Consumer<ExecutionSupport>> getExternalRegistrations()

reset

public void reset(boolean isConfiguring)

finalizeConfiguration

public void finalizeConfiguration()

clear

public void clear(double tickTime)

couldBreatheCached

public boolean couldBreatheCached()

forEachPlayer

public <T,U,V> void forEachPlayer(@Nonnull
 DoubleQuadObjectConsumer<Ref<EntityStore>, T, U, V> consumer,
 T t,
 U u,
 V v,
 double d,
 ComponentAccessor<EntityStore> componentAccessor)

getClosestPlayerInRange

@Nullable
public Ref<EntityStore> getClosestPlayerInRange(double minRange,
 double maxRange,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

getClosestPlayerInRange

@Nullable
public Ref<EntityStore> getClosestPlayerInRange(double minRange,
 double maxRange,
 @Nonnull
 Predicate<Ref<EntityStore>> filter,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

getClosestNPCInRange

@Nullable
public Ref<EntityStore> getClosestNPCInRange(double minRange,
 double maxRange,
 @Nonnull
 Predicate<Ref<EntityStore>> filter,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

processNPCsInRange

public <S,T> void processNPCsInRange(@Nonnull
 Ref<EntityStore> ref,
 double minRange,
 double maxRange,
 boolean useProjectedDistance,
 Ref<EntityStore> ignoredEntityReference,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nonnull
 QuadPredicate<S, Ref<EntityStore>, ExecutionSupport, T> filter,
 S s,
 T t,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

processPlayersInRange

public <S,T> void processPlayersInRange(@Nonnull
 Ref<EntityStore> ref,
 double minRange,
 double maxRange,
 boolean useProjectedDistance,
 Ref<EntityStore> ignoredEntityReference,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nonnull
 QuadPredicate<S, Ref<EntityStore>, ExecutionSupport, T> filter,
 S s,
 T t,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

processEntitiesInRange

public <S,T> void processEntitiesInRange(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 EntityList entities,
 double minRange,
 double maxRange,
 boolean useProjectedDistance,
 Ref<EntityStore> ignoredEntityReference,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nonnull
 QuadPredicate<S, Ref<EntityStore>, ExecutionSupport, T> filter,
 S s,
 T t,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

getClosestDroppedItemInRange

@Nullable
public <S> Ref<EntityStore> getClosestDroppedItemInRange(@Nonnull
 Ref<EntityStore> ref,
 double minRange,
 double maxRange,
 @Nonnull
 TriPredicate<S, Ref<EntityStore>, ComponentAccessor<EntityStore>> filter,
 S s,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

isEntityCountInRange

public <S> boolean isEntityCountInRange(double minRange,
 double maxRange,
 int minCount,
 int maxCount,
 boolean findPlayers,
 int roleIndex,
 @Nonnull
 QuadPredicate<S, Ref<EntityStore>, Integer, ComponentAccessor<EntityStore>> filter,
 S s,
 ComponentAccessor<EntityStore> componentAccessor)

countEntitiesInRange

public <S,T> int countEntitiesInRange(double minRange,
 double maxRange,
 boolean findPlayers,
 @Nonnull
 QuadPredicate<S, Ref<EntityStore>, T, ComponentAccessor<EntityStore>> filter,
 S s,
 T t,
 ComponentAccessor<EntityStore> componentAccessor)

requirePlayerDistanceSorted

public void requirePlayerDistanceSorted(double v)

requirePlayerDistanceUnsorted

public void requirePlayerDistanceUnsorted(double v)

requirePlayerDistanceAvoidance

public void requirePlayerDistanceAvoidance(double v)

requireEntityDistanceSorted

public void requireEntityDistanceSorted(double v)

requireEntityDistanceUnsorted

public void requireEntityDistanceUnsorted(double v)

requireEntityDistanceAvoidance

public void requireEntityDistanceAvoidance(double v)

requireDroppedItemDistance

public void requireDroppedItemDistance(double value)

requireSpawnMarkerDistance

public void requireSpawnMarkerDistance(double value)

requireSpawnBeaconDistance

public void requireSpawnBeaconDistance(int value)

forEachNPCUnordered

public <T,U,V,R> void forEachNPCUnordered(double maxDistance,
 @Nonnull
 QuadPredicate<Ref<EntityStore>, T, U, ComponentAccessor<EntityStore>> predicate,
 @Nonnull
 QuadConsumer<Ref<EntityStore>, T, V, R> consumer,
 T t,
 U u,
 V v,
 R r,
 ComponentAccessor<EntityStore> componentAccessor)

forEachEntityInAvoidanceRange

public <T> void forEachEntityInAvoidanceRange(@Nonnull
 Set<Ref<EntityStore>> ignoredEntitiesForAvoidance,
 @Nonnull
 TriConsumer<Ref<EntityStore>, T, CommandBuffer<EntityStore>> consumer,
 T t,
 CommandBuffer<EntityStore> commandBuffer)

forEachEntityInAvoidanceRange

public <T,U> void forEachEntityInAvoidanceRange(@Nonnull
 Set<Ref<EntityStore>> ignoredEntitiesForAvoidance,
 @Nonnull
 QuadConsumer<Ref<EntityStore>, T, U, CommandBuffer<EntityStore>> consumer,
 T t,
 U u,
 CommandBuffer<EntityStore> commandBuffer)

setOpaqueBlockSet

public void setOpaqueBlockSet(int blockSet)

hasLineOfSight

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

hasInverseLineOfSight

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

isFriendlyBlockingLineOfSight

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

getDroppedItemList

@Nonnull
public List<Ref<EntityStore>> getDroppedItemList()

getSpawnMarkerList

@Nonnull
public List<Ref<EntityStore>> getSpawnMarkerList()

getSpawnBeaconList

@Nonnull
public List<Ref<EntityStore>> getSpawnBeaconList()

clone

public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.