org.spongepowered.api.block.tileentity

Interface MobSpawner

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Locatable, PropertyHolder, TileEntity, ValueContainer<DataHolder>

public interface MobSpawner
extends TileEntity

Represents a Monster Spawner.

Method Summary

Modifier and Type	Method and Description
default MobSpawnerData	getMobSpawnerData() Gets the MobSpawnerData for this mob spawner.
default MutableBoundedValue<Short>	maximumNearbyEntities() Gets the MutableBoundedValue for the limitation on the number of nearby Entity instances can exist near the owning spawner.
default MutableBoundedValue<Short>	maximumSpawnDelay() Gets the MutableBoundedValue for the maximum spawn delay required between attempts to spawn an Entity.
default MutableBoundedValue<Short>	minimumSpawnDelay() Gets the MutableBoundedValue for the minimum spawn delay required between attempts to spawn an Entity.
default Value<WeightedSerializableObject<EntityArchetype>>	nextEntityToSpawn() Gets the Value for the overridden WeightedSerializableObject<EntitySnapshot> to spawn next.
default WeightedCollectionValue<EntityArchetype>	possibleEntitiesToSpawn() Gets the WeightedCollectionValue of all possible Entity instances that can be spawned by the spawner.
default MutableBoundedValue<Short>	remainingDelay() Gets the MutableBoundedValue for the remaining delay before a new attempt at spawning an Entity is made.
default MutableBoundedValue<Short>	requiredPlayerRange() Gets the MutableBoundedValue for the minimum range a Player must remain in proximity of the spawner, such that if a Player is NOT within the provided range, no attempts to spawn an Entity is made.
default MutableBoundedValue<Short>	spawnCount() Gets the MutableBoundedValue for the count of successful spawns of all Entity instances from the owning spawner.
void	spawnEntityBatchImmediately(boolean force) Trigger an immediate spawn of a batch of entities.
default MutableBoundedValue<Short>	spawnRange() Gets the MutableBoundedValue for the maximum range that an Entity can be spawned from the spawner.

Methods inherited from interface org.spongepowered.api.block.tileentity.TileEntity

createArchetype, getBlock, getLocatableBlock, getType, isValid, setValid

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.world.Locatable

getLocation, getWorld

Method Detail

spawnEntityBatchImmediately

void spawnEntityBatchImmediately(boolean force)

Trigger an immediate spawn of a batch of entities.

This will obey the restrictions of maximum nearby entities and player range unless the force flag is set.

Parameters:

force - Whether to ignore spawning restrictions

getMobSpawnerData

default MobSpawnerData getMobSpawnerData()

Gets the MobSpawnerData for this mob spawner.

Returns:

the mob spawner's associated data

remainingDelay

default MutableBoundedValue<Short> remainingDelay()

Gets the MutableBoundedValue for the remaining delay before a new attempt at spawning an Entity is made.

Returns:

The immutable bounded value for the remaining delay

minimumSpawnDelay

default MutableBoundedValue<Short> minimumSpawnDelay()

Gets the MutableBoundedValue for the minimum spawn delay required between attempts to spawn an Entity.

Returns:

The bounded value of the minimum spawn delay

maximumSpawnDelay

default MutableBoundedValue<Short> maximumSpawnDelay()

Gets the MutableBoundedValue for the maximum spawn delay required between attempts to spawn an Entity.

Returns:

The bounded value of the maximum spawn delay

spawnCount

default MutableBoundedValue<Short> spawnCount()

Gets the MutableBoundedValue for the count of successful spawns of all Entity instances from the owning spawner. This count is simply a total count, there is no limitation on how many attempts are made to spawn an Entity.

Returns:

The immutable bounded value

maximumNearbyEntities

default MutableBoundedValue<Short> maximumNearbyEntities()

Gets the MutableBoundedValue for the limitation on the number of nearby Entity instances can exist near the owning spawner. The limitation is that if there are more Entity instances than the provided value, no attempts to spawn a new Entity will be made.

Returns:

The bounded value of the maximum supported nearby entities

requiredPlayerRange

default MutableBoundedValue<Short> requiredPlayerRange()

Gets the MutableBoundedValue for the minimum range a Player must remain in proximity of the spawner, such that if a Player is NOT within the provided range, no attempts to spawn an Entity is made.

Returns:

The value of the required player range to spawn entities

spawnRange

default MutableBoundedValue<Short> spawnRange()

Gets the MutableBoundedValue for the maximum range that an Entity can be spawned from the spawner.

Returns:

The immutable value of the maximum spawn range an entity can be spawned

nextEntityToSpawn

default Value<WeightedSerializableObject<EntityArchetype>> nextEntityToSpawn()

Gets the Value for the overridden WeightedSerializableObject<EntitySnapshot> to spawn next. If possible, the next entity to spawn may be chosen from the already provided possibleEntitiesToSpawn().

Returns:

The next possible entity to spawn

possibleEntitiesToSpawn

default WeightedCollectionValue<EntityArchetype> possibleEntitiesToSpawn()

Gets the WeightedCollectionValue of all possible Entity instances that can be spawned by the spawner. As they are all WeightedSerializableObject<EntitySnapshot> instances, their weight is defined as a Random to determine the next Entity that will be spawned, unless overriden by nextEntityToSpawn().

Returns:

The immutable weighted entity collection value of entities