com.pixelmonmod.pixelmon.api.spawning.archetypes.spawners

Class TickingSpawner

java.lang.Object

com.pixelmonmod.pixelmon.api.spawning.AbstractSpawner

com.pixelmonmod.pixelmon.api.spawning.archetypes.spawners.TickingSpawner

Direct Known Subclasses:

LegendarySpawner, PlayerTrackingSpawner

public abstract class TickingSpawner
extends AbstractSpawner

An AbstractSpawner which ticks. This implementation provides a way of establishing different passes so that on each cycle a different process is taken. This by default uses PixelmonConfig options for its operational parameters including capacity, maximum spawns per pass, frequency, and distance between spawns.

Created by Hiroku

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TickingSpawner.TickingSpawnerBuilder<T extends TickingSpawner>

Nested classes/interfaces inherited from class com.pixelmonmod.pixelmon.api.spawning.AbstractSpawner

AbstractSpawner.SpawnerBuilder<T extends AbstractSpawner>

Field Summary

Fields

Modifier and Type	Field and Description
int	capacity The maximum number of entities that may exist in the world as a result of this spawner at any one time.
long	lastCycleTime The last (epoch) time a cycle occurred for this spawner.
float	minDistBetweenSpawns The minimum distance that must exist between spawned entities.
long	nextSpawnTime The last (epoch) time an entity was successfully spawned.
float	spawnFrequency The number of seconds between each pass.
ICalculateSpawnLocations	spawnLocationCalculator The ICalculateSpawnLocations that will be used to take BlockCollections and compose SpawnLocations.
int	spawnsPerPass The maximum number of entities that can spawn during a single pass.

Fields inherited from class com.pixelmonmod.pixelmon.api.spawning.AbstractSpawner

cacheSets, checkSpawns, conditions, isBusy, lastSpawnTime, name, rarityMultipliers, rarityTweaks, selectionAlgorithm, spawnedTracker, spawnSets, tweaks

Constructor Summary

Constructors

Constructor and Description
TickingSpawner(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	canSpawn(SpawnAction<?> action)
void	doPass(SpawnerCoordinator coordinator) Performs a pass.
abstract int	getNumPasses() Gets the number of passes.
abstract java.util.List<SpawnAction<? extends net.minecraft.entity.Entity>>	getSpawns(int pass) Performs a specific pass, where pass index starts at zero, returning a list of SpawnActions that should execute.
boolean	hasCapacity(int numSpawns) Gets if the spawner has enough space for the given number of entities.
void	onSpawnEnded()
boolean	shouldDoSpawning() Whether or not this spawner should do spawning when it is triggered

Methods inherited from class com.pixelmonmod.pixelmon.api.spawning.AbstractSpawner

calculateSpatialData, fits, getCondition, getSuitableSpawns, getTrackedBlockCollection, getTweak, getWeightedSpawnInfo, hasCondition, hasTweak

Methods inherited from class java.lang.Object

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

Field Detail

lastCycleTime

public long lastCycleTime

The last (epoch) time a cycle occurred for this spawner.

nextSpawnTime

public long nextSpawnTime

The last (epoch) time an entity was successfully spawned.

spawnLocationCalculator

public ICalculateSpawnLocations spawnLocationCalculator

The ICalculateSpawnLocations that will be used to take BlockCollections and compose SpawnLocations.

capacity

public int capacity

The maximum number of entities that may exist in the world as a result of this spawner at any one time. This can be bypassed by overriding hasCapacity(int).

spawnsPerPass

public int spawnsPerPass

The maximum number of entities that can spawn during a single pass.

spawnFrequency

public float spawnFrequency

The number of seconds between each pass.

minDistBetweenSpawns

public float minDistBetweenSpawns

The minimum distance that must exist between spawned entities. The lower this is, the more clustered entities may spawn.

Constructor Detail

TickingSpawner

public TickingSpawner(java.lang.String name)

Method Detail

getSpawns

public abstract java.util.List<SpawnAction<? extends net.minecraft.entity.Entity>> getSpawns(int pass)

Performs a specific pass, where pass index starts at zero, returning a list of SpawnActions that should execute. Null or empty lists are acceptable. An implementation that doesn't use passes will ignore this parameter.

getNumPasses

public abstract int getNumPasses()

Gets the number of passes. An implementation that doesn't use passes will return 1.

hasCapacity

public boolean hasCapacity(int numSpawns)

Gets if the spawner has enough space for the given number of entities. By default this considers the capacity and the maximumSpawnedPokemon.

canSpawn

public boolean canSpawn(SpawnAction<?> action)

shouldDoSpawning

public boolean shouldDoSpawning()

Description copied from class: AbstractSpawner

Whether or not this spawner should do spawning when it is triggered

Overrides:

shouldDoSpawning in class AbstractSpawner

onSpawnEnded

public void onSpawnEnded()

doPass

public void doPass(SpawnerCoordinator coordinator)

Performs a pass. This checks for capacity, calls getSpawns(int), and executes any SpawnActions.