Class NPCPlugin

java.lang.Object

com.hypixel.hytale.server.core.plugin.PluginBase

com.hypixel.hytale.server.core.plugin.JavaPlugin

com.hypixel.hytale.server.npc.NPCPlugin

All Implemented Interfaces:

CommandOwner

public class NPCPlugin
extends JavaPlugin

Since:

15/3/18

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NPCPlugin.NPCConfig
static class	NPCPlugin.NPCEntityRegenerateStatsSystem

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FACTORY_CLASS_ACTION
static final String	FACTORY_CLASS_ACTION_LIST
static final String	FACTORY_CLASS_BODY_MOTION
static final String	FACTORY_CLASS_HEAD_MOTION
static final String	FACTORY_CLASS_INSTRUCTION
static final String	FACTORY_CLASS_ROLE
static final String	FACTORY_CLASS_SENSOR
static final String	FACTORY_CLASS_TRANSIENT_PATH
static final EnumCodec<MovementMode>	MOVEMENT_MODE_CODEC
static final SetCodec<MovementMode, EnumSet<MovementMode>>	MOVEMENT_MODE_SET_CODEC
static final short	PRIORITY_LOAD_NPC
static final short	PRIORITY_SPAWN_VALIDATION
static final String	ROLE_ASSETS_PATH

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
NPCPlugin(JavaPluginInit init)

Method Summary

Modifier and Type	Method	Description
static Role	buildRole(Holder<EntityStore> holder, Builder<Role> roleBuilder, BuilderInfo builderInfo, BuilderSupport builderSupport, int roleIndex)
void	collectRoleTick(int roleIndex, long nanos)
void	collectSensorSupportEntityList(int roleIndex, long getNanos, double maxEntityDistanceSorted, double maxEntityDistance, double maxEntityDistanceAvoidance, int numEntities)
void	collectSensorSupportFriendlyBlockingTest(int roleIndex, boolean cacheHit)
void	collectSensorSupportInverseLosTest(int roleIndex, boolean cacheHit)
void	collectSensorSupportLosTest(int roleIndex, boolean cacheHit, long time)
void	collectSensorSupportPlayerList(int roleIndex, long getNanos, double maxPlayerDistanceSorted, double maxPlayerDistance, double maxPlayerDistanceAvoidance, int numPlayers)
void	collectSensorSupportTickDone(int roleIndex)
void	forceValidation(int builderIndex)
void	generateDescriptors()
static NPCPlugin	get()
ComponentType<EntityStore, AlarmStore>	getAlarmStoreComponentType()
ResourceType<EntityStore, AStarNodePoolProviderSimple>	getAStarNodePoolProviderSimpleResourceType()
AttitudeMap	getAttitudeMap()
List<BeaconReceiverProvider>	getBeaconReceiverProviders()
ComponentType<EntityStore, BeaconSupport>	getBeaconSupportComponentType()
ResourceType<EntityStore, Blackboard>	getBlackboardResourceType()
ComponentType<EntityStore, BlackboardSubscription>	getBlackboardSubscriptionComponentType()
BuilderInfo	getBuilderInfo(Builder<?> builder)
BuilderManager	getBuilderManager()
ComponentType<EntityStore, CombatViewSystems.CombatData>	getCombatDataComponentType()
ResourceType<EntityStore, CombatViewSystems.CombatDataPool>	getCombatDataPoolResourceType()
ComponentType<EntityStore, CombatSupport>	getCombatSupportComponentType()
ComponentType<EntityStore, DebugSupport>	getDebugSupportComponentType()
ComponentType<EntityStore, DisplayNameSupport>	getDisplayNameSupportComponentType()
ComponentType<EntityStore, EntitySupport>	getEntitySupportComponentType()
ComponentType<EntityStore, FailedSpawnComponent>	getFailedSpawnComponentType()
ComponentType<EntityStore, FlagsComponent>	getFlagsComponentType()
int	getIndex(String builderName)
ItemAttitudeMap	getItemAttitudeMap()
ComponentType<EntityStore, MarkedEntitySupport>	getMarkedEntitySupportComponentType()
int	getMaxBlackboardBlockCountPerType()
ComponentType<EntityStore, MotionContextSupport>	getMotionContextSupportComponentType()
String	getName(int builderIndex)
ResourceType<EntityStore, NewSpawnStartTickingSystem.QueueResource>	getNewSpawnStartTickingQueueResourceType()
ComponentType<EntityStore, NPCBlockEventSupport>	getNpcBlockEventSupportComponentType()
ComponentType<EntityStore, NPCEntityEventSupport>	getNpcEntityEventSupportComponentType()
ResourceType<EntityStore, SpatialResource<Ref<EntityStore>, EntityStore>>	getNpcSpatialResource()
ComponentType<EntityStore, NPCRunTestsCommand.NPCTestData>	getNpcTestDataComponentType()
int	getPathChangeRevision()
ComponentType<EntityStore, PlayerBlockEventSupport>	getPlayerBlockEventSupportComponentType()
ComponentType<EntityStore, PlayerEntityEventSupport>	getPlayerEntityEventSupportComponentType()
ComponentType<EntityStore, PlayerTaskSupport>	getPlayerTaskSupportComponentType()
ComponentType<EntityStore, PositionCache>	getPositionCacheComponentType()
String[]	getPresetCoverageTestNPCs()
BuilderInfo	getRoleBuilderInfo(int roleIndex)
ResourceType<EntityStore, RoleChangeSystem.RoleChangeQueue>	getRoleChangeQueueResourceType()
List<String>	getRoleTemplateNames(boolean spawnableOnly)
ResourceType<EntityStore, SortBufferProviderResource>	getSortBufferProviderResourceResourceType()
ComponentType<EntityStore, SpawnLineage>	getSpawnLineageComponentType()
ResourceType<EntityStore, SpawnNPCInteractionFailureTracker>	getSpawnNPCInteractionFailureTrackerResourceType()
ComponentType<EntityStore, StateEvaluator>	getStateEvaluatorComponentType()
ComponentType<EntityStore, StateSupport>	getStateSupportComponentType()
ComponentType<EntityStore, StepComponent>	getStepComponentType()
ComponentType<EntityStore, Timers>	getTimersComponentType()
ComponentType<EntityStore, ValueStore>	getValueStoreComponentType()
ComponentType<EntityStore, WorldSupport>	getWorldSupportComponentType()
boolean	hasRoleName(String roleName)
boolean	isBenchmarkingRole()
boolean	isBenchmarkingSensorSupport()
boolean	isLogFailingTestErrors()
BuilderInfo	prepareRoleBuilderInfo(int roleIndex)
void	registerBeaconReceiverProvider(BeaconReceiverProvider provider)	Registers a provider of additional, non-NPC beacon receivers.
<T> NPCPlugin	registerCoreComponentType(String name, Supplier<Builder<T>> builder)
static void	reloadNPCsWithRole(int roleIndex)
void	saveDescriptors()
void	setBuilderInvalid(int builderIndex)
void	setRoleBuilderNeedsReload(Builder<?> builder)
void	setupNPCLoading()
it.unimi.dsi.fastutil.Pair<Ref<EntityStore>, NPCEntity>	spawnEntity(Store<EntityStore> store, int roleIndex, org.joml.Vector3dc position, Rotation3fc rotation, Model spawnModel, TriConsumer<NPCEntity, Holder<EntityStore>, Store<EntityStore>> preAddToWorld, TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)	Called to spawn and return an NPC entity in the given world.
it.unimi.dsi.fastutil.Pair<Ref<EntityStore>, NPCEntity>	spawnEntity(Store<EntityStore> store, int roleIndex, org.joml.Vector3dc position, Rotation3fc rotation, Model spawnModel, TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)	Called to spawn and return an NPC entity in the given world.
it.unimi.dsi.fastutil.Pair<Ref<EntityStore>, INonPlayerCharacter>	spawnNPC(Store<EntityStore> store, String npcType, String groupType, org.joml.Vector3dc position, Rotation3fc rotation)	Called to spawn and returns an NPC in the given world.
SpawnTestResult	spawnNPCWithColumnProbe(Store<EntityStore> store, String npcType, String groupType, World world, int worldBlockX, int worldBlockZ, double yHint, Rotation3fc rotation)	Spawns an NPC using column probing (SpawningContext.set(World, double, double, double) then SpawningContext.canSpawn()), for cases where an exact pose is blocked but a nearby column may fit (including ground placement for walkers).
SpawnTestResult	spawnNPCWithColumnProbe(Store<EntityStore> store, String npcType, String groupType, World world, int worldBlockX, int worldBlockZ, double yHint, Rotation3fc rotation, TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)	Spawns an NPC using column probing, with an optional post-spawn callback.
SpawnTestResult	spawnNPCWithSpaceValidation(Store<EntityStore> store, String npcType, String groupType, org.joml.Vector3dc position, Rotation3fc rotation)	Called to spawn and return an NPC entity in the given world if the NPC can fit at the supplied exact position.
SpawnTestResult	spawnNPCWithSpaceValidation(Store<EntityStore> store, String npcType, String groupType, org.joml.Vector3dc position, Rotation3fc rotation, TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)	Called to spawn and return an NPC entity in the given world if the NPC can fit at the supplied exact position, with an optional post-spawn callback.
SpawnTestResult	spawnNPCWithSpaceValidation(Store<EntityStore> store, String npcType, String groupType, org.joml.Vector3dc position, Rotation3fc rotation, TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn, boolean cubeBlockersOnly, boolean centerHitbox)
boolean	startRoleBenchmark(double seconds, Consumer<it.unimi.dsi.fastutil.ints.Int2ObjectMap<TimeDistributionRecorder>> onFinished)
boolean	startSensorSupportBenchmark(double seconds, Consumer<it.unimi.dsi.fastutil.ints.Int2ObjectMap<SensorSupportBenchmark>> onFinished)
boolean	testAndValidateRole(BuilderInfo builderInfo)
Builder<Role>	tryGetCachedValidRole(int roleIndex)
void	validateSpawnableRole(String roleName)

Methods inherited from class JavaPlugin

getClassLoader, getFile, getType

Methods inherited from class PluginBase

getAssetRegistry, getBasePermission, getChunkStoreRegistry, getClientFeatureRegistry, getCodecRegistry, getCodecRegistry, getCodecRegistry, getCommandRegistry, getDataDirectory, getEntityRegistry, getEntityStoreRegistry, getEventRegistry, getIdentifier, getLogger, getManifest, getName, getState, getTaskRegistry, isDisabled, isEnabled, preLoad

Methods inherited from class Object

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

Field Details

FACTORY_CLASS_ROLE

@Nonnull
public static final String FACTORY_CLASS_ROLE

See Also:

• Constant Field Values

FACTORY_CLASS_BODY_MOTION

@Nonnull
public static final String FACTORY_CLASS_BODY_MOTION

See Also:

• Constant Field Values

FACTORY_CLASS_HEAD_MOTION

@Nonnull
public static final String FACTORY_CLASS_HEAD_MOTION

See Also:

• Constant Field Values

FACTORY_CLASS_ACTION

@Nonnull
public static final String FACTORY_CLASS_ACTION

See Also:

• Constant Field Values

FACTORY_CLASS_SENSOR

@Nonnull
public static final String FACTORY_CLASS_SENSOR

See Also:

• Constant Field Values

FACTORY_CLASS_INSTRUCTION

@Nonnull
public static final String FACTORY_CLASS_INSTRUCTION

See Also:

• Constant Field Values

FACTORY_CLASS_TRANSIENT_PATH

@Nonnull
public static final String FACTORY_CLASS_TRANSIENT_PATH

See Also:

• Constant Field Values

FACTORY_CLASS_ACTION_LIST

@Nonnull
public static final String FACTORY_CLASS_ACTION_LIST

See Also:

• Constant Field Values

ROLE_ASSETS_PATH

@Nonnull
public static final String ROLE_ASSETS_PATH

See Also:

• Constant Field Values

MOVEMENT_MODE_CODEC

@Nonnull
public static final EnumCodec<MovementMode> MOVEMENT_MODE_CODEC

MOVEMENT_MODE_SET_CODEC

@Nonnull
public static final SetCodec<MovementMode, EnumSet<MovementMode>> MOVEMENT_MODE_SET_CODEC

PRIORITY_LOAD_NPC

public static final short PRIORITY_LOAD_NPC

See Also:

• Constant Field Values

PRIORITY_SPAWN_VALIDATION

public static final short PRIORITY_SPAWN_VALIDATION

See Also:

• Constant Field Values

Constructor Details

NPCPlugin

public NPCPlugin(@Nonnull
 JavaPluginInit init)

Method Details

get

public static NPCPlugin get()

getBlackboardResourceType

public ResourceType<EntityStore, Blackboard> getBlackboardResourceType()

getBlackboardSubscriptionComponentType

@Nonnull
public ComponentType<EntityStore, BlackboardSubscription> getBlackboardSubscriptionComponentType()

getCombatDataPoolResourceType

public ResourceType<EntityStore, CombatViewSystems.CombatDataPool> getCombatDataPoolResourceType()

getRoleChangeQueueResourceType

public ResourceType<EntityStore, RoleChangeSystem.RoleChangeQueue> getRoleChangeQueueResourceType()

getNewSpawnStartTickingQueueResourceType

public ResourceType<EntityStore, NewSpawnStartTickingSystem.QueueResource> getNewSpawnStartTickingQueueResourceType()

getSortBufferProviderResourceResourceType

public ResourceType<EntityStore, SortBufferProviderResource> getSortBufferProviderResourceResourceType()

getAStarNodePoolProviderSimpleResourceType

public ResourceType<EntityStore, AStarNodePoolProviderSimple> getAStarNodePoolProviderSimpleResourceType()

getNpcSpatialResource

public ResourceType<EntityStore, SpatialResource<Ref<EntityStore>, EntityStore>> getNpcSpatialResource()

registerBeaconReceiverProvider

public void registerBeaconReceiverProvider(@Nonnull
 BeaconReceiverProvider provider)

Registers a provider of additional, non-NPC beacon receivers.

getBeaconReceiverProviders

@Nonnull
public List<BeaconReceiverProvider> getBeaconReceiverProviders()

getSpawnNPCInteractionFailureTrackerResourceType

public ResourceType<EntityStore, SpawnNPCInteractionFailureTracker> getSpawnNPCInteractionFailureTrackerResourceType()

getCombatDataComponentType

public ComponentType<EntityStore, CombatViewSystems.CombatData> getCombatDataComponentType()

getNpcTestDataComponentType

public ComponentType<EntityStore, NPCRunTestsCommand.NPCTestData> getNpcTestDataComponentType()

getBeaconSupportComponentType

public ComponentType<EntityStore, BeaconSupport> getBeaconSupportComponentType()

getNpcBlockEventSupportComponentType

public ComponentType<EntityStore, NPCBlockEventSupport> getNpcBlockEventSupportComponentType()

getPlayerBlockEventSupportComponentType

public ComponentType<EntityStore, PlayerBlockEventSupport> getPlayerBlockEventSupportComponentType()

getNpcEntityEventSupportComponentType

public ComponentType<EntityStore, NPCEntityEventSupport> getNpcEntityEventSupportComponentType()

getPlayerEntityEventSupportComponentType

public ComponentType<EntityStore, PlayerEntityEventSupport> getPlayerEntityEventSupportComponentType()

getCombatSupportComponentType

public ComponentType<EntityStore, CombatSupport> getCombatSupportComponentType()

getStateSupportComponentType

public ComponentType<EntityStore, StateSupport> getStateSupportComponentType()

getMarkedEntitySupportComponentType

public ComponentType<EntityStore, MarkedEntitySupport> getMarkedEntitySupportComponentType()

getWorldSupportComponentType

public ComponentType<EntityStore, WorldSupport> getWorldSupportComponentType()

getEntitySupportComponentType

public ComponentType<EntityStore, EntitySupport> getEntitySupportComponentType()

getMotionContextSupportComponentType

public ComponentType<EntityStore, MotionContextSupport> getMotionContextSupportComponentType()

getDisplayNameSupportComponentType

public ComponentType<EntityStore, DisplayNameSupport> getDisplayNameSupportComponentType()

getPlayerTaskSupportComponentType

public ComponentType<EntityStore, PlayerTaskSupport> getPlayerTaskSupportComponentType()

getPositionCacheComponentType

public ComponentType<EntityStore, PositionCache> getPositionCacheComponentType()

getDebugSupportComponentType

public ComponentType<EntityStore, DebugSupport> getDebugSupportComponentType()

getAlarmStoreComponentType

public ComponentType<EntityStore, AlarmStore> getAlarmStoreComponentType()

getSpawnLineageComponentType

public ComponentType<EntityStore, SpawnLineage> getSpawnLineageComponentType()

getFlagsComponentType

public ComponentType<EntityStore, FlagsComponent> getFlagsComponentType()

getStepComponentType

public ComponentType<EntityStore, StepComponent> getStepComponentType()

getFailedSpawnComponentType

public ComponentType<EntityStore, FailedSpawnComponent> getFailedSpawnComponentType()

getTimersComponentType

public ComponentType<EntityStore, Timers> getTimersComponentType()

getStateEvaluatorComponentType

public ComponentType<EntityStore, StateEvaluator> getStateEvaluatorComponentType()

getValueStoreComponentType

public ComponentType<EntityStore, ValueStore> getValueStoreComponentType()

setupNPCLoading

public void setupNPCLoading()

getPresetCoverageTestNPCs

public String[] getPresetCoverageTestNPCs()

spawnNPC

@Nullable
public it.unimi.dsi.fastutil.Pair<Ref<EntityStore>, INonPlayerCharacter> spawnNPC(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String npcType,
 @Nullable
 String groupType,
 @Nonnull
 org.joml.Vector3dc position,
 @Nonnull
 Rotation3fc rotation)

Called to spawn and returns an NPC in the given world.

Parameters:

store - The Store<EntityStore> for component access.

npcType - The type of NPC to spawn.

groupType - A reference to the group definition to spawn.

position - The position to spawn at.

rotation - The rotation to spawn with.

Returns:

the spawned NPC, or null if the NPC type is invalid.

spawnNPCWithSpaceValidation

@Nonnull
public SpawnTestResult spawnNPCWithSpaceValidation(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String npcType,
 @Nullable
 String groupType,
 @Nonnull
 org.joml.Vector3dc position,
 @Nonnull
 Rotation3fc rotation)

Called to spawn and return an NPC entity in the given world if the NPC can fit at the supplied exact position.

Parameters:

store - The Store<EntityStore> for component access.

npcType - The type of NPC to spawn.

groupType - A reference to the group definition to spawn.

position - The exact position to validate and spawn at.

rotation - The rotation to spawn with.

Returns:

A SpawnTestResult: SpawnTestResult.TEST_OK for success, SpawnTestResult.FAIL_INVALID_POSITION if not enough space or chunk unloaded, SpawnTestResult.FAIL_NOT_SPAWNABLE if the NPC type is invalid or not spawnable, or SpawnTestResult.FAIL_SPAWN if an error occurred during entity spawning.

spawnNPCWithSpaceValidation

@Nonnull
public SpawnTestResult spawnNPCWithSpaceValidation(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String npcType,
 @Nullable
 String groupType,
 @Nonnull
 org.joml.Vector3dc position,
 @Nonnull
 Rotation3fc rotation,
 @Nullable
 TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)

Called to spawn and return an NPC entity in the given world if the NPC can fit at the supplied exact position, with an optional post-spawn callback.

Parameters:

store - The Store<EntityStore> for component access.

npcType - The type of NPC to spawn.

groupType - A reference to the group definition to spawn.

position - The exact position to validate and spawn at.

rotation - The rotation to spawn with.

postSpawn - Optional callback invoked after the NPC has been spawned.

Returns:

A SpawnTestResult: SpawnTestResult.TEST_OK for success, SpawnTestResult.FAIL_INVALID_POSITION if not enough space or chunk unloaded, SpawnTestResult.FAIL_NOT_SPAWNABLE if the NPC type is invalid or not spawnable, or SpawnTestResult.FAIL_SPAWN if an error occurred during entity spawning.

spawnNPCWithSpaceValidation

@Nonnull
public SpawnTestResult spawnNPCWithSpaceValidation(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String npcType,
 @Nullable
 String groupType,
 @Nonnull
 org.joml.Vector3dc position,
 @Nonnull
 Rotation3fc rotation,
 @Nullable
 TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn,
 boolean cubeBlockersOnly,
 boolean centerHitbox)

Parameters:

cubeBlockersOnly - When true, only full-cube blocks invalidate the exact position; partial models (ropes, plants, cocoons, etc.) are ignored. Used for mid-air spawns that emerge from decorative non-cube blocks.

centerHitbox - When true, the supplied position is treated as the desired center of the NPC's collision box rather than its origin; the origin is shifted so the box centers on that point.

spawnNPCWithColumnProbe

@Nonnull
public SpawnTestResult spawnNPCWithColumnProbe(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String npcType,
 @Nullable
 String groupType,
 @Nonnull
 World world,
 int worldBlockX,
 int worldBlockZ,
 double yHint,
 @Nonnull
 Rotation3fc rotation)

Spawns an NPC using column probing (SpawningContext.set(World, double, double, double) then SpawningContext.canSpawn()), for cases where an exact pose is blocked but a nearby column may fit (including ground placement for walkers).

Parameters:

store - entity store

npcType - role id

groupType - optional flock group

world - world

worldBlockX - world block X of the column to probe

worldBlockZ - world block Z of the column to probe

yHint - vertical hint for span selection (typically primary spawn Y)

rotation - NPC rotation

Returns:

SpawnTestResult.TEST_OK if spawned; SpawnTestResult.FAIL_INVALID_POSITION if column/set/canSpawn unsuitable; SpawnTestResult.FAIL_NOT_SPAWNABLE if role invalid; SpawnTestResult.FAIL_SPAWN if entity add failed

spawnNPCWithColumnProbe

@Nonnull
public SpawnTestResult spawnNPCWithColumnProbe(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String npcType,
 @Nullable
 String groupType,
 @Nonnull
 World world,
 int worldBlockX,
 int worldBlockZ,
 double yHint,
 @Nonnull
 Rotation3fc rotation,
 @Nullable
 TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)

Spawns an NPC using column probing, with an optional post-spawn callback.

Parameters:

store - entity store

npcType - role id

groupType - optional flock group

world - world

worldBlockX - world block X of the column to probe

worldBlockZ - world block Z of the column to probe

yHint - vertical hint for span selection (typically primary spawn Y)

rotation - NPC rotation

postSpawn - optional callback invoked after the NPC has been spawned

Returns:

SpawnTestResult.TEST_OK if spawned; SpawnTestResult.FAIL_INVALID_POSITION if column/set/canSpawn unsuitable; SpawnTestResult.FAIL_NOT_SPAWNABLE if role invalid; SpawnTestResult.FAIL_SPAWN if entity add failed

reloadNPCsWithRole

public static void reloadNPCsWithRole(int roleIndex)

getPathChangeRevision

public int getPathChangeRevision()

getName

@Nullable
public String getName(int builderIndex)

getIndex

public int getIndex(String builderName)

tryGetCachedValidRole

@Nullable
public Builder<Role> tryGetCachedValidRole(int roleIndex)

getBuilderInfo

@Nullable
public BuilderInfo getBuilderInfo(Builder<?> builder)

getRoleTemplateNames

public List<String> getRoleTemplateNames(boolean spawnableOnly)

hasRoleName

public boolean hasRoleName(String roleName)

validateSpawnableRole

public void validateSpawnableRole(String roleName)

getRoleBuilderInfo

@Nullable
public BuilderInfo getRoleBuilderInfo(int roleIndex)

setBuilderInvalid

public void setBuilderInvalid(int builderIndex)

getAttitudeMap

public AttitudeMap getAttitudeMap()

getItemAttitudeMap

public ItemAttitudeMap getItemAttitudeMap()

testAndValidateRole

public boolean testAndValidateRole(@Nullable
 BuilderInfo builderInfo)

forceValidation

public void forceValidation(int builderIndex)

spawnEntity

@Nullable
public it.unimi.dsi.fastutil.Pair<Ref<EntityStore>, NPCEntity> spawnEntity(@Nonnull
 Store<EntityStore> store,
 int roleIndex,
 @Nonnull
 org.joml.Vector3dc position,
 @Nullable
 Rotation3fc rotation,
 @Nullable
 Model spawnModel,
 @Nullable
 TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)

Called to spawn and return an NPC entity in the given world.

Parameters:

store - The Store<EntityStore> for component access.

roleIndex - The index of the role to spawn.

position - The position at which to spawn the NPC.

rotation - The rotation to apply to the NPC.

spawnModel - The model to use when spawning the NPC.

postSpawn - A consumer that is called after the NPC has been spawned.

Returns:

a pair containing the reference to the spawned entity and the NPCEntity component, or null if the role index is invalid.

spawnEntity

@Nullable
public it.unimi.dsi.fastutil.Pair<Ref<EntityStore>, NPCEntity> spawnEntity(@Nonnull
 Store<EntityStore> store,
 int roleIndex,
 @Nonnull
 org.joml.Vector3dc position,
 @Nullable
 Rotation3fc rotation,
 @Nullable
 Model spawnModel,
 @Nullable
 TriConsumer<NPCEntity, Holder<EntityStore>, Store<EntityStore>> preAddToWorld,
 @Nullable
 TriConsumer<NPCEntity, Ref<EntityStore>, Store<EntityStore>> postSpawn)

Called to spawn and return an NPC entity in the given world.

Parameters:

store - The Store<EntityStore> for component access.

roleIndex - The index of the role to spawn.

position - The position at which to spawn the NPC.

rotation - The rotation to apply to the NPC.

spawnModel - The model to use when spawning the NPC.

preAddToWorld - A consumer that is called before the NPC is added to the world.

postSpawn - A consumer that is called after the NPC has been spawned.

Returns:

a pair containing the reference to the spawned entity and the NPCEntity component, or null if the role index is invalid.

prepareRoleBuilderInfo

@Nonnull
public BuilderInfo prepareRoleBuilderInfo(int roleIndex)

buildRole

@Nonnull
public static Role buildRole(@Nonnull
 Holder<EntityStore> holder,
 @Nonnull
 Builder<Role> roleBuilder,
 @Nonnull
 BuilderInfo builderInfo,
 @Nonnull
 BuilderSupport builderSupport,
 int roleIndex)

generateDescriptors

public void generateDescriptors()

saveDescriptors

public void saveDescriptors()

getBuilderManager

public BuilderManager getBuilderManager()

getMaxBlackboardBlockCountPerType

public int getMaxBlackboardBlockCountPerType()

isLogFailingTestErrors

public boolean isLogFailingTestErrors()

startRoleBenchmark

public boolean startRoleBenchmark(double seconds,
 @Nonnull
 Consumer<it.unimi.dsi.fastutil.ints.Int2ObjectMap<TimeDistributionRecorder>> onFinished)

collectRoleTick

public void collectRoleTick(int roleIndex,
 long nanos)

isBenchmarkingRole

public boolean isBenchmarkingRole()

startSensorSupportBenchmark

public boolean startSensorSupportBenchmark(double seconds,
 @Nonnull
 Consumer<it.unimi.dsi.fastutil.ints.Int2ObjectMap<SensorSupportBenchmark>> onFinished)

isBenchmarkingSensorSupport

public boolean isBenchmarkingSensorSupport()

collectSensorSupportPlayerList

public void collectSensorSupportPlayerList(int roleIndex,
 long getNanos,
 double maxPlayerDistanceSorted,
 double maxPlayerDistance,
 double maxPlayerDistanceAvoidance,
 int numPlayers)

collectSensorSupportEntityList

public void collectSensorSupportEntityList(int roleIndex,
 long getNanos,
 double maxEntityDistanceSorted,
 double maxEntityDistance,
 double maxEntityDistanceAvoidance,
 int numEntities)

collectSensorSupportLosTest

public void collectSensorSupportLosTest(int roleIndex,
 boolean cacheHit,
 long time)

collectSensorSupportInverseLosTest

public void collectSensorSupportInverseLosTest(int roleIndex,
 boolean cacheHit)

collectSensorSupportFriendlyBlockingTest

public void collectSensorSupportFriendlyBlockingTest(int roleIndex,
 boolean cacheHit)

collectSensorSupportTickDone

public void collectSensorSupportTickDone(int roleIndex)

registerCoreComponentType

@Nonnull
public <T> NPCPlugin registerCoreComponentType(String name,
 @Nonnull
 Supplier<Builder<T>> builder)

setRoleBuilderNeedsReload

public void setRoleBuilderNeedsReload(Builder<?> builder)