Class SpawningPlugin

java.lang.Object

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

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

com.hypixel.hytale.server.spawning.SpawningPlugin

All Implemented Interfaces:

CommandOwner

public class SpawningPlugin
extends JavaPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpawningPlugin.NPCSpawningConfig

Field Summary

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
SpawningPlugin(JavaPluginInit init)

Method Summary

Modifier and Type	Method	Description
static SpawningPlugin	get()
List<BeaconSpawnWrapper>	getBeaconSpawnsForEnvironment(int environmentIndex)
BeaconSpawnWrapper	getBeaconSpawnWrapper(int configId)
ComponentType<ChunkStore, ChunkSpawnData>	getChunkSpawnDataComponentType()
ComponentType<ChunkStore, ChunkSpawnedNPCData>	getChunkSpawnedNPCDataComponentType()
ComponentType<ChunkStore, ChunkSuppressionEntry>	getChunkSuppressionEntryComponentType()
ResourceType<ChunkStore, ChunkSuppressionQueue>	getChunkSuppressionQueueResourceType()
double	getEnvironmentDensity(int environmentIndex)
ResourceType<EntityStore, FloodFillEntryPoolProviderSimple>	getFloodFillEntryPoolProviderSimpleResourceType()
ComponentType<EntityStore, FloodFillPositionSelector>	getFloodFillPositionSelectorComponentType()
ComponentType<EntityStore, InitialBeaconDelay>	getInitialBeaconDelayComponentType()
ComponentType<EntityStore, LocalSpawnBeacon>	getLocalSpawnBeaconComponentType()
ComponentType<EntityStore, LocalSpawnController>	getLocalSpawnControllerComponentType()
double	getLocalSpawnControllerJoinDelay()
ResourceType<EntityStore, LocalSpawnState>	getLocalSpawnStateResourceType()
ResourceType<EntityStore, SpatialResource<Ref<EntityStore>, EntityStore>>	getManualSpawnBeaconSpatialResource()
int	getMaxActiveJobs()
it.unimi.dsi.fastutil.ints.IntSet	getRolesForEnvironment(int environment)
ComponentType<EntityStore, SpawnBeaconReference>	getSpawnBeaconReferenceComponentType()
ComponentType<ChunkStore, SpawnJobData>	getSpawnJobDataComponentType()
ComponentType<ChunkStore, SpawnMarkerBlock>	getSpawnMarkerBlockComponentType()
ComponentType<EntityStore, SpawnMarkerBlockReference>	getSpawnMarkerBlockReferenceComponentType()
ComponentType<EntityStore, SpawnMarkerEntity>	getSpawnMarkerComponentType()
ComponentType<EntityStore, SpawnMarkerDebug>	getSpawnMarkerDebugComponentType()
Model	getSpawnMarkerModel()
ComponentType<EntityStore, SpawnMarkerReference>	getSpawnMarkerReferenceComponentType()
ResourceType<EntityStore, SpatialResource<Ref<EntityStore>, EntityStore>>	getSpawnMarkerSpatialResource()
ComponentType<EntityStore, SpawnMarkerValidation>	getSpawnMarkerValidationComponentType()
ResourceType<EntityStore, SpawnPositionSearchWorkspace>	getSpawnPositionSearchWorkspaceResourceType()
ResourceType<EntityStore, SpawnSuppressionController>	getSpawnSuppressionControllerResourceType()
ComponentType<EntityStore, SpawnSuppressionComponent>	getSpawnSuppressorComponentType()
int	getTickColumnBudget()
EnvironmentSpawnParameters	getWorldEnvironmentSpawnParameters(int environmentIndex)
ResourceType<EntityStore, WorldSpawnData>	getWorldSpawnDataResourceType()
boolean	isAutoRemoveInvalidMarkers()
boolean	isDebugInvalidMarkers()
void	setAutoRemoveInvalidMarkers(boolean autoRemoveInvalidMarkers)
void	setDebugInvalidMarkers(boolean debugInvalidMarkers)
void	setup()
boolean	shouldNPCDespawn(Store<EntityStore> store, NPCEntity npcComponent, WorldTimeResource timeManager, int configuration, boolean beaconSpawn)
void	shutdown()
void	start()
static void	validateSpawnMarkers(Map<String, SpawnMarker> markers, List<String> errors)	Called to validate each spawn marker's configurations, ensuring that all NPC roles exist.
static <T extends NPCSpawn> void	validateSpawnsConfigurations(String type, Map<String,T> spawns, List<String> errors)

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

Constructor Details

SpawningPlugin

public SpawningPlugin(@Nonnull
 JavaPluginInit init)

Method Details

get

public static SpawningPlugin get()

setup

public void setup()

start

public void start()

shutdown

public void shutdown()

getSpawnMarkerSpatialResource

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

getManualSpawnBeaconSpatialResource

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

getSpawnMarkerComponentType

public ComponentType<EntityStore, SpawnMarkerEntity> getSpawnMarkerComponentType()

getSpawnMarkerDebugComponentType

public ComponentType<EntityStore, SpawnMarkerDebug> getSpawnMarkerDebugComponentType()

getSpawnMarkerValidationComponentType

public ComponentType<EntityStore, SpawnMarkerValidation> getSpawnMarkerValidationComponentType()

getLocalSpawnControllerComponentType

public ComponentType<EntityStore, LocalSpawnController> getLocalSpawnControllerComponentType()

getWorldSpawnDataResourceType

public ResourceType<EntityStore, WorldSpawnData> getWorldSpawnDataResourceType()

getSpawnPositionSearchWorkspaceResourceType

public ResourceType<EntityStore, SpawnPositionSearchWorkspace> getSpawnPositionSearchWorkspaceResourceType()

getSpawnSuppressorComponentType

public ComponentType<EntityStore, SpawnSuppressionComponent> getSpawnSuppressorComponentType()

getSpawnSuppressionControllerResourceType

public ResourceType<EntityStore, SpawnSuppressionController> getSpawnSuppressionControllerResourceType()

getLocalSpawnBeaconComponentType

public ComponentType<EntityStore, LocalSpawnBeacon> getLocalSpawnBeaconComponentType()

getLocalSpawnStateResourceType

public ResourceType<EntityStore, LocalSpawnState> getLocalSpawnStateResourceType()

getInitialBeaconDelayComponentType

public ComponentType<EntityStore, InitialBeaconDelay> getInitialBeaconDelayComponentType()

getSpawnJobDataComponentType

public ComponentType<ChunkStore, SpawnJobData> getSpawnJobDataComponentType()

getChunkSpawnDataComponentType

public ComponentType<ChunkStore, ChunkSpawnData> getChunkSpawnDataComponentType()

getChunkSpawnedNPCDataComponentType

public ComponentType<ChunkStore, ChunkSpawnedNPCData> getChunkSpawnedNPCDataComponentType()

getChunkSuppressionQueueResourceType

public ResourceType<ChunkStore, ChunkSuppressionQueue> getChunkSuppressionQueueResourceType()

getFloodFillEntryPoolProviderSimpleResourceType

public ResourceType<EntityStore, FloodFillEntryPoolProviderSimple> getFloodFillEntryPoolProviderSimpleResourceType()

getChunkSuppressionEntryComponentType

public ComponentType<ChunkStore, ChunkSuppressionEntry> getChunkSuppressionEntryComponentType()

getBeaconSpawnWrapper

public BeaconSpawnWrapper getBeaconSpawnWrapper(int configId)

getSpawnMarkerReferenceComponentType

public ComponentType<EntityStore, SpawnMarkerReference> getSpawnMarkerReferenceComponentType()

getSpawnBeaconReferenceComponentType

public ComponentType<EntityStore, SpawnBeaconReference> getSpawnBeaconReferenceComponentType()

getFloodFillPositionSelectorComponentType

public ComponentType<EntityStore, FloodFillPositionSelector> getFloodFillPositionSelectorComponentType()

getSpawnMarkerBlockReferenceComponentType

public ComponentType<EntityStore, SpawnMarkerBlockReference> getSpawnMarkerBlockReferenceComponentType()

getSpawnMarkerBlockComponentType

public ComponentType<ChunkStore, SpawnMarkerBlock> getSpawnMarkerBlockComponentType()

shouldNPCDespawn

public boolean shouldNPCDespawn(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 NPCEntity npcComponent,
 @Nonnull
 WorldTimeResource timeManager,
 int configuration,
 boolean beaconSpawn)

getSpawnMarkerModel

public Model getSpawnMarkerModel()

getWorldEnvironmentSpawnParameters

public EnvironmentSpawnParameters getWorldEnvironmentSpawnParameters(int environmentIndex)

getBeaconSpawnsForEnvironment

public List<BeaconSpawnWrapper> getBeaconSpawnsForEnvironment(int environmentIndex)

getRolesForEnvironment

public it.unimi.dsi.fastutil.ints.IntSet getRolesForEnvironment(int environment)

getTickColumnBudget

public int getTickColumnBudget()

getMaxActiveJobs

public int getMaxActiveJobs()

isAutoRemoveInvalidMarkers

public boolean isAutoRemoveInvalidMarkers()

setAutoRemoveInvalidMarkers

public void setAutoRemoveInvalidMarkers(boolean autoRemoveInvalidMarkers)

isDebugInvalidMarkers

public boolean isDebugInvalidMarkers()

setDebugInvalidMarkers

public void setDebugInvalidMarkers(boolean debugInvalidMarkers)

getLocalSpawnControllerJoinDelay

public double getLocalSpawnControllerJoinDelay()

validateSpawnsConfigurations

public static <T extends NPCSpawn> void validateSpawnsConfigurations(@Nonnull
 String type,
 @Nonnull
 Map<String,T> spawns,
 @Nonnull
 List<String> errors)

validateSpawnMarkers

public static void validateSpawnMarkers(@Nonnull
 Map<String, SpawnMarker> markers,
 @Nonnull
 List<String> errors)

Called to validate each spawn marker's configurations, ensuring that all NPC roles exist.

Parameters:

markers - The map of spawn markers to validate.

errors - The list to add error messages to.

getEnvironmentDensity

public double getEnvironmentDensity(int environmentIndex)