AbstractSpawner (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.spawning.AbstractSpawner

Direct Known Subclasses:

TickingSpawner, TriggerSpawner
```
public abstract class AbstractSpawner
extends java.lang.Object
```
The base of all spawning. The primary implementations are TriggerSpawner and TickingSpawner. Instantiated implementations of this base should be added to the coordinator in PixelmonSpawning.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractSpawner.SpawnerBuilder<T extends AbstractSpawner>

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractSpawner.SpawnerBuilder<T extends AbstractSpawner>`

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.HashMap<net.minecraft.util.ResourceLocation,java.util.List<SpawnInfo>>`	`cacheSets`
`CheckSpawns`	`checkSpawns` The `CheckSpawns` used when /checkspawns `name` is used.
`java.util.List<SpawnerCondition>`	`conditions` A list of `SpawnerCondition`s to apply to potential spawns to filter early.
`boolean`	`isBusy` Whether or not the spawner is currently busy doing processing.
`long`	`lastSpawnTime` The last time an entity spawned because of this spawner.
`java.lang.String`	`name` The unique name of the spawner.
`java.util.List<RarityMultiplier>`	`rarityMultipliers` A list of rarity multipliers to apply to all the spawns this processes.
`java.util.List<RarityTweak>`	`rarityTweaks` A list of rarity tweaks to apply to spawns.
`SelectionAlgorithm`	`selectionAlgorithm` The `SelectionAlgorithm` used to choose a spawn from a list with a location.
`SpawnedTracker`	`spawnedTracker` The maintained list of spawned entities.
`java.util.List<SpawnSet>`	`spawnSets` The `SpawnSet`s contained in this spawner.
`java.util.List<SpawningTweak>`	`tweaks` A list of `SpawningTweak`s to apply to the entities spawned.

Constructor Summary

Constructors
Constructor and Description

AbstractSpawner(java.lang.String name)

Constructors
Constructor and Description
`AbstractSpawner(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SpatialData`	`calculateSpatialData(net.minecraft.world.World world, net.minecraft.util.math.BlockPos centre, int max, boolean includeDownwards, java.util.function.Predicate<net.minecraft.block.Block> condition)` Calculates a `SpatialData` for the given parameters.
`boolean`	`fits(SpawnInfo spawnInfo, SpawnLocation spawnLocation)` Whether or not this spawner finds it acceptable for this `SpawnInfo` to spawn at this `SpawnLocation`.
`<T extends SpawnerCondition> T`	`getCondition(java.lang.Class<T> clazz)` Gets the `SpawnerCondition` of the given type, if it exists.
`java.util.List<SpawnInfo>`	`getSuitableSpawns(SpawnLocation spawnLocation)` Gets all the spawns from the contained sets that suit the given `SpawnLocation`.
`java.util.concurrent.CompletableFuture<BlockCollection>`	`getTrackedBlockCollection(net.minecraft.entity.Entity entity, float horizontalTrackFactor, float verticalTrackFactor, int horizontalSliceRadius, int verticalSliceRadius, int minDistFromCentre, int maxDistFromCentre)` Tracks the given entity's motion using the given parameters, and returns an appropriately sized `BlockCollection`
`<T extends SpawningTweak> T`	`getTweak(java.lang.Class<T> clazz)` Gets the `SpawningTweak` of the given type, if it exists.
`SpawnInfo`	`getWeightedSpawnInfo(SpawnLocation spawnLocation)` Gets the `SpawnInfo` to spawn at the given `SpawnLocation` based off what is suitable and chosen by `selectionAlgorithm`.
`boolean`	`hasCondition(java.lang.Class<? extends SpawnerCondition> clazz)` Returns true if this spawner has a particular `SpawnerCondition` present.
`boolean`	`hasTweak(java.lang.Class<? extends SpawningTweak> clazz)` Returns true if this spawner has a particular `SpawningTweak` present.
`boolean`	`shouldDoSpawning()` Whether or not this spawner should do spawning when it is triggered

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
public final java.lang.String name
```
    The unique name of the spawner.
  - spawnedTracker
```
public final SpawnedTracker spawnedTracker
```
    The maintained list of spawned entities.
  - selectionAlgorithm
```
public SelectionAlgorithm selectionAlgorithm
```
    The SelectionAlgorithm used to choose a spawn from a list with a location.
  - checkSpawns
```
public CheckSpawns checkSpawns
```
    The CheckSpawns used when /checkspawns name is used. By default it simply states not implemented.
  - tweaks
```
public java.util.List<SpawningTweak> tweaks
```
    A list of SpawningTweaks to apply to the entities spawned.
  - conditions
```
public java.util.List<SpawnerCondition> conditions
```
    A list of SpawnerConditions to apply to potential spawns to filter early.
  - rarityTweaks
```
public java.util.List<RarityTweak> rarityTweaks
```
    A list of rarity tweaks to apply to spawns.
  - rarityMultipliers
```
public java.util.List<RarityMultiplier> rarityMultipliers
```
    A list of rarity multipliers to apply to all the spawns this processes.
  - isBusy
```
public volatile boolean isBusy
```
    Whether or not the spawner is currently busy doing processing.
  - lastSpawnTime
```
public long lastSpawnTime
```
    The last time an entity spawned because of this spawner.
  - spawnSets
```
public java.util.List<SpawnSet> spawnSets
```
    The SpawnSets contained in this spawner.
  - cacheSets
```
public transient java.util.HashMap<net.minecraft.util.ResourceLocation,java.util.List<SpawnInfo>> cacheSets
```
- Constructor Detail
  - AbstractSpawner
```
public AbstractSpawner(java.lang.String name)
```
- Method Detail
  - shouldDoSpawning
```
public boolean shouldDoSpawning()
```
    Whether or not this spawner should do spawning when it is triggered
  - getSuitableSpawns
```
public java.util.List<SpawnInfo> getSuitableSpawns(SpawnLocation spawnLocation)
```
    Gets all the spawns from the contained sets that suit the given SpawnLocation.
  - fits
```
public boolean fits(SpawnInfo spawnInfo,
                    SpawnLocation spawnLocation)
```
    Whether or not this spawner finds it acceptable for this SpawnInfo to spawn at this SpawnLocation. Occurs after SpawnCondition#fits
  - getWeightedSpawnInfo
```
@Nullable
public SpawnInfo getWeightedSpawnInfo(SpawnLocation spawnLocation)
```
    Gets the SpawnInfo to spawn at the given SpawnLocation based off what is suitable and chosen by selectionAlgorithm.
  - calculateSpatialData
```
public SpatialData calculateSpatialData(net.minecraft.world.World world,
                                        net.minecraft.util.math.BlockPos centre,
                                        int max,
                                        boolean includeDownwards,
                                        java.util.function.Predicate<net.minecraft.block.Block> condition)
```
    Calculates a SpatialData for the given parameters.
    
    Parameters:
    
    world - - The world this is in.
    
    centre - - The blockpos for the centre of the area. This is the base block for spawning.
    
    max - - The largest diameter to search. If it encounters obstacles, this will be cut short, being the returned diameter.
    
    includeDownwards - - Whether or not the radial checks should move toward -ve y as well or just focus upwards.
    
    condition - - The condition on the surrounding blocks that must be met for it to count towards the available space.
    
    Returns:
    
    - A new SpatialData with all its information.
  - getTrackedBlockCollection
```
public java.util.concurrent.CompletableFuture<BlockCollection> getTrackedBlockCollection(net.minecraft.entity.Entity entity,
                                                                                         float horizontalTrackFactor,
                                                                                         float verticalTrackFactor,
                                                                                         int horizontalSliceRadius,
                                                                                         int verticalSliceRadius,
                                                                                         int minDistFromCentre,
                                                                                         int maxDistFromCentre)
```
    Tracks the given entity's motion using the given parameters, and returns an appropriately sized BlockCollection
    
    Parameters:
    
    entity - - The entity to track.
    
    horizontalTrackFactor - - The coefficient for tracking horizontal entity motion.
    
    verticalTrackFactor - - The coefficient for tracking vertical entity motion.
    
    horizontalSliceRadius - - The horizontal diameter of the BlockCollection.
    
    verticalSliceRadius - - The vertical diameter of the BlockCollection.
    
    minDistFromCentre - - The minimum distance from the tracked position that the BlockCollection may be centred on.
    
    maxDistFromCentre - - The maximum distance from the tracked position that the BlockCollection may be centred on.
    
    Returns:
    
    - A BlockCollection that tracked the entity's motion to give a random but predictive collection.
  - hasTweak
```
public boolean hasTweak(java.lang.Class<? extends SpawningTweak> clazz)
```
    Returns true if this spawner has a particular SpawningTweak present.
  - getTweak
```
@Nullable
public <T extends SpawningTweak> T getTweak(java.lang.Class<T> clazz)
```
    Gets the SpawningTweak of the given type, if it exists. This could be null.
  - hasCondition
```
public boolean hasCondition(java.lang.Class<? extends SpawnerCondition> clazz)
```
    Returns true if this spawner has a particular SpawnerCondition present.
  - getCondition
```
@Nullable
public <T extends SpawnerCondition> T getCondition(java.lang.Class<T> clazz)
```
    Gets the SpawnerCondition of the given type, if it exists. This could be null.

Class AbstractSpawner

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

spawnedTracker

selectionAlgorithm

checkSpawns

tweaks

conditions

rarityTweaks

rarityMultipliers

isBusy

lastSpawnTime

spawnSets

cacheSets

Constructor Detail

AbstractSpawner

Method Detail

shouldDoSpawning

getSuitableSpawns

fits

getWeightedSpawnInfo

calculateSpatialData

getTrackedBlockCollection

hasTweak

getTweak

hasCondition

getCondition