Package com.hypixel.hytale.server.spawning

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.LegacySpawnSuppressorEntityMigration	Deprecated, for removal: This API element is subject to removal in a future version.
static class	SpawningPlugin.NPCSpawningConfig

Field Summary

Fields

Modifier and Type	Field	Description
private final BeaconSpawnManager	beaconSpawnManager
private ComponentType<ChunkStore,ChunkSpawnData>	chunkSpawnDataComponentType
private ComponentType<ChunkStore,ChunkSpawnedNPCData>	chunkSpawnedNPCDataComponentType
private ComponentType<ChunkStore,ChunkSuppressionEntry>	chunkSuppressionEntryComponentType
private ResourceType<ChunkStore,ChunkSuppressionQueue>	chunkSuppressionQueueResourceType
private final Config<SpawningPlugin.NPCSpawningConfig>	config
private static final String	DEFAULT_SPAWN_MARKER_MODEL
private ResourceType<EntityStore,FloodFillEntryPoolProviderSimple>	floodFillEntryPoolProviderSimpleResourceType
private ComponentType<EntityStore,com.hypixel.hytale.server.spawning.util.FloodFillPositionSelector>	floodFillPositionSelectorComponentType
private ComponentType<EntityStore,InitialBeaconDelay>	initialBeaconDelayComponentType
private static SpawningPlugin	instance
private ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>>	legacyBeaconSpatialResource
private ComponentType<EntityStore,LocalSpawnBeacon>	localSpawnBeaconComponentType
private ComponentType<EntityStore,LocalSpawnController>	localSpawnControllerComponentType
private double	localSpawnControllerJoinDelay
private ResourceType<EntityStore,LocalSpawnState>	localSpawnStateResourceType
private ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>>	manualSpawnBeaconSpatialResource
private static final int	OVERPOPULATION_GROUP_BUFFER
private static final float	OVERPOPULATION_RATIO
private ComponentType<EntityStore,SpawnBeaconReference>	spawnBeaconReferenceComponentType
private ComponentType<ChunkStore,SpawnJobData>	spawnJobDataComponentType
private ComponentType<EntityStore,SpawnMarkerBlockReference>	spawnMarkerBlockReferenceComponentType
private ComponentType<EntityStore,SpawnMarkerEntity>	spawnMarkerComponentType
private Model	spawnMarkerModel
private ComponentType<EntityStore,SpawnMarkerReference>	spawnMarkerReferenceComponentType
private ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>>	spawnMarkerSpatialResource
private ResourceType<EntityStore,SpawnSuppressionController>	spawnSuppressionControllerResourceType
private ComponentType<EntityStore,SpawnSuppressionComponent>	spawnSuppressorComponentType
private static final int	TICK_COLUMN_BUDGET
private int	tickColumnBudget
private ResourceType<EntityStore,WorldSpawnData>	worldSpawnDataResourceType
private final WorldSpawnManager	worldSpawnManager

Fields inherited from class com.hypixel.hytale.server.core.plugin.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,com.hypixel.hytale.server.spawning.util.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<EntityStore,SpawnMarkerBlockReference>	getSpawnMarkerBlockReferenceComponentType()
ComponentType<EntityStore,SpawnMarkerEntity>	getSpawnMarkerComponentType()
Model	getSpawnMarkerModel()
ComponentType<EntityStore,SpawnMarkerReference>	getSpawnMarkerReferenceComponentType()
ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>>	getSpawnMarkerSpatialResource()
ResourceType<EntityStore,SpawnSuppressionController>	getSpawnSuppressionControllerResourceType()
ComponentType<EntityStore,SpawnSuppressionComponent>	getSpawnSuppressorComponentType()
int	getTickColumnBudget()
EnvironmentSpawnParameters	getWorldEnvironmentSpawnParameters(int environmentIndex)
ResourceType<EntityStore,WorldSpawnData>	getWorldSpawnDataResourceType()
private void	onBeaconNPCSpawnsLoaded(LoadedAssetsEvent<String,BeaconNPCSpawn,IndexedLookupTableAssetMap<String,BeaconNPCSpawn>> event)
private void	onBeaconNPCSpawnsRemoved(RemovedAssetsEvent<String,BeaconNPCSpawn,IndexedLookupTableAssetMap<String,BeaconNPCSpawn>> event)
private void	onEnvironmentChange(LoadedAssetsEvent<String,Environment,IndexedLookupTableAssetMap<String,Environment>> event)
private void	onLoadAsset(LoadAssetEvent event)
private void	onLoadedNPCEvent(AllNPCsLoadedEvent loadedNPCEvent)
private void	onModelAssetChange(LoadedAssetsEvent<String,ModelAsset,DefaultAssetMap<String,ModelAsset>> event)
protected void	onSpawnMarkersChange(LoadedAssetsEvent<String,SpawnMarker,DefaultAssetMap<String,SpawnMarker>> event)
protected static void	onSpawnMarkersRemove(RemovedAssetsEvent<String,SpawnMarker,DefaultAssetMap<String,SpawnMarker>> event)
private void	onWorldNPCSpawnsLoaded(LoadedAssetsEvent<String,WorldNPCSpawn,IndexedLookupTableAssetMap<String,WorldNPCSpawn>> event)
private void	onWorldNPCSpawnsRemoved(RemovedAssetsEvent<String,WorldNPCSpawn,IndexedLookupTableAssetMap<String,WorldNPCSpawn>> event)
private void	rebuildBeaconSpawnConfigurations(it.unimi.dsi.fastutil.ints.IntSet changeSet)
void	setup()
private void	setUpWithAllRoles()
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)
static <T extends NPCSpawn> void	validateSpawnsConfigurations(String type, Map<String,T> spawns, List<String> errors)

Methods inherited from class com.hypixel.hytale.server.core.plugin.JavaPlugin

getClassLoader, getFile, getType, start0

Methods inherited from class com.hypixel.hytale.server.core.plugin.PluginBase

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

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SPAWN_MARKER_MODEL

private static final String DEFAULT_SPAWN_MARKER_MODEL

See Also:

• Constant Field Values

TICK_COLUMN_BUDGET

private static final int TICK_COLUMN_BUDGET

See Also:

• Constant Field Values

OVERPOPULATION_RATIO

private static final float OVERPOPULATION_RATIO

See Also:

• Constant Field Values

OVERPOPULATION_GROUP_BUFFER

private static final int OVERPOPULATION_GROUP_BUFFER

See Also:

• Constant Field Values

instance

private static SpawningPlugin instance

spawnMarkerModel

private Model spawnMarkerModel

localSpawnControllerJoinDelay

private double localSpawnControllerJoinDelay

tickColumnBudget

private int tickColumnBudget

worldSpawnManager

private final WorldSpawnManager worldSpawnManager

beaconSpawnManager

private final BeaconSpawnManager beaconSpawnManager

config

private final Config<SpawningPlugin.NPCSpawningConfig> config

legacyBeaconSpatialResource

private ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>> legacyBeaconSpatialResource

spawnMarkerSpatialResource

private ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>> spawnMarkerSpatialResource

manualSpawnBeaconSpatialResource

private ResourceType<EntityStore,SpatialResource<Ref<EntityStore>,EntityStore>> manualSpawnBeaconSpatialResource

spawnMarkerComponentType

private ComponentType<EntityStore,SpawnMarkerEntity> spawnMarkerComponentType

localSpawnControllerComponentType

private ComponentType<EntityStore,LocalSpawnController> localSpawnControllerComponentType

worldSpawnDataResourceType

private ResourceType<EntityStore,WorldSpawnData> worldSpawnDataResourceType

spawnSuppressorComponentType

private ComponentType<EntityStore,SpawnSuppressionComponent> spawnSuppressorComponentType

spawnSuppressionControllerResourceType

private ResourceType<EntityStore,SpawnSuppressionController> spawnSuppressionControllerResourceType

localSpawnBeaconComponentType

private ComponentType<EntityStore,LocalSpawnBeacon> localSpawnBeaconComponentType

localSpawnStateResourceType

private ResourceType<EntityStore,LocalSpawnState> localSpawnStateResourceType

spawnJobDataComponentType

private ComponentType<ChunkStore,SpawnJobData> spawnJobDataComponentType

chunkSpawnDataComponentType

private ComponentType<ChunkStore,ChunkSpawnData> chunkSpawnDataComponentType

chunkSpawnedNPCDataComponentType

private ComponentType<ChunkStore,ChunkSpawnedNPCData> chunkSpawnedNPCDataComponentType

chunkSuppressionQueueResourceType

private ResourceType<ChunkStore,ChunkSuppressionQueue> chunkSuppressionQueueResourceType

chunkSuppressionEntryComponentType

private ComponentType<ChunkStore,ChunkSuppressionEntry> chunkSuppressionEntryComponentType

initialBeaconDelayComponentType

private ComponentType<EntityStore,InitialBeaconDelay> initialBeaconDelayComponentType

spawnMarkerReferenceComponentType

private ComponentType<EntityStore,SpawnMarkerReference> spawnMarkerReferenceComponentType

spawnBeaconReferenceComponentType

private ComponentType<EntityStore,SpawnBeaconReference> spawnBeaconReferenceComponentType

floodFillPositionSelectorComponentType

private ComponentType<EntityStore,com.hypixel.hytale.server.spawning.util.FloodFillPositionSelector> floodFillPositionSelectorComponentType

floodFillEntryPoolProviderSimpleResourceType

private ResourceType<EntityStore,FloodFillEntryPoolProviderSimple> floodFillEntryPoolProviderSimpleResourceType

spawnMarkerBlockReferenceComponentType

private ComponentType<EntityStore,SpawnMarkerBlockReference> spawnMarkerBlockReferenceComponentType

Constructor Details

SpawningPlugin

public SpawningPlugin(@Nonnull
 JavaPluginInit init)

Method Details

get

public static SpawningPlugin get()

setup

public void setup()

Overrides:

setup in class PluginBase

start

public void start()

Overrides:

start in class PluginBase

shutdown

public void shutdown()

Overrides:

shutdown in class PluginBase

getSpawnMarkerSpatialResource

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

getManualSpawnBeaconSpatialResource

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

getSpawnMarkerComponentType

public ComponentType<EntityStore,SpawnMarkerEntity> getSpawnMarkerComponentType()

getLocalSpawnControllerComponentType

public ComponentType<EntityStore,LocalSpawnController> getLocalSpawnControllerComponentType()

getWorldSpawnDataResourceType

public ResourceType<EntityStore,WorldSpawnData> getWorldSpawnDataResourceType()

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,com.hypixel.hytale.server.spawning.util.FloodFillPositionSelector> getFloodFillPositionSelectorComponentType()

getSpawnMarkerBlockReferenceComponentType

public ComponentType<EntityStore,SpawnMarkerBlockReference> getSpawnMarkerBlockReferenceComponentType()

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()

getLocalSpawnControllerJoinDelay

public double getLocalSpawnControllerJoinDelay()

validateSpawnsConfigurations

public static <T extends NPCSpawn> void validateSpawnsConfigurations(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)

getEnvironmentDensity

public double getEnvironmentDensity(int environmentIndex)

onSpawnMarkersChange

protected void onSpawnMarkersChange(@Nonnull
 LoadedAssetsEvent<String,SpawnMarker,DefaultAssetMap<String,SpawnMarker>> event)

onSpawnMarkersRemove

protected static void onSpawnMarkersRemove(@Nonnull
 RemovedAssetsEvent<String,SpawnMarker,DefaultAssetMap<String,SpawnMarker>> event)

onEnvironmentChange

private void onEnvironmentChange(@Nonnull
 LoadedAssetsEvent<String,Environment,IndexedLookupTableAssetMap<String,Environment>> event)

onWorldNPCSpawnsLoaded

private void onWorldNPCSpawnsLoaded(@Nonnull
 LoadedAssetsEvent<String,WorldNPCSpawn,IndexedLookupTableAssetMap<String,WorldNPCSpawn>> event)

onBeaconNPCSpawnsLoaded

private void onBeaconNPCSpawnsLoaded(@Nonnull
 LoadedAssetsEvent<String,BeaconNPCSpawn,IndexedLookupTableAssetMap<String,BeaconNPCSpawn>> event)

onWorldNPCSpawnsRemoved

private void onWorldNPCSpawnsRemoved(@Nonnull
 RemovedAssetsEvent<String,WorldNPCSpawn,IndexedLookupTableAssetMap<String,WorldNPCSpawn>> event)

onBeaconNPCSpawnsRemoved

private void onBeaconNPCSpawnsRemoved(@Nonnull
 RemovedAssetsEvent<String,BeaconNPCSpawn,IndexedLookupTableAssetMap<String,BeaconNPCSpawn>> event)

onLoadedNPCEvent

private void onLoadedNPCEvent(@Nonnull
 AllNPCsLoadedEvent loadedNPCEvent)

setUpWithAllRoles

private void setUpWithAllRoles()

rebuildBeaconSpawnConfigurations

private void rebuildBeaconSpawnConfigurations(@Nullable
 it.unimi.dsi.fastutil.ints.IntSet changeSet)

onModelAssetChange

private void onModelAssetChange(@Nonnull
 LoadedAssetsEvent<String,ModelAsset,DefaultAssetMap<String,ModelAsset>> event)

onLoadAsset

private void onLoadAsset(@Nonnull
 LoadAssetEvent event)