org.spongepowered.api.data.manipulator.mutable

Interface MobSpawnerData

All Superinterfaces:

DataManipulator<MobSpawnerData,ImmutableMobSpawnerData>, DataSerializable, ValueContainer<MobSpawnerData>

public interface MobSpawnerData
extends DataManipulator<MobSpawnerData,ImmutableMobSpawnerData>

Represents the data associated with a mob spawner, including the spawn delay, the spawn count, and the list of possible entities that can be spawned.

Method Summary

Modifier and Type	Method and Description
MutableBoundedValue<Short>	maximumNearbyEntities() Gets the MutableBoundedValue for the limitation on the number of nearby Entity instances can exist near the owning spawner.
MutableBoundedValue<Short>	maximumSpawnDelay() Gets the MutableBoundedValue for the maximum spawn delay required between attempts to spawn an Entity.
MutableBoundedValue<Short>	minimumSpawnDelay() Gets the MutableBoundedValue for the minimum spawn delay required between attempts to spawn an Entity.
Value<WeightedSerializableObject<EntityArchetype>>	nextEntityToSpawn() Gets the Value for the overridden WeightedSerializableObject<EntityArchetype> to spawn next.
WeightedCollectionValue<EntityArchetype>	possibleEntitiesToSpawn() Gets the WeightedCollectionValue of all possible Entity instances that can be spawned by the spawner.
MutableBoundedValue<Short>	remainingDelay() Gets the MutableBoundedValue for the remaining delay before a new attempt at spawning an Entity is made.
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.
MutableBoundedValue<Short>	spawnCount() Gets the MutableBoundedValue for the count of successful spawns of all Entity instances from the owning spawner.
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.data.manipulator.DataManipulator

asImmutable, copy, fill, fill, from, set, set, set, set, transform

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

getContentVersion, toContainer

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

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

Method Detail

remainingDelay

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

See Also:

Keys.SPAWNER_REMAINING_DELAY

minimumSpawnDelay

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

See Also:

Keys.SPAWNER_MINIMUM_DELAY

maximumSpawnDelay

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

See Also:

Keys.SPAWNER_MAXIMUM_DELAY

spawnCount

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

See Also:

Keys.SPAWNER_SPAWN_COUNT

maximumNearbyEntities

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

See Also:

Keys.SPAWNER_MAXIMUM_NEARBY_ENTITIES

requiredPlayerRange

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

See Also:

Keys.SPAWNER_REQUIRED_PLAYER_RANGE

spawnRange

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

See Also:

Keys.SPAWNER_SPAWN_RANGE

nextEntityToSpawn

Value<WeightedSerializableObject<EntityArchetype>> nextEntityToSpawn()

Gets the Value for the overridden WeightedSerializableObject<EntityArchetype> 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

See Also:

Keys.SPAWNER_NEXT_ENTITY_TO_SPAWN

possibleEntitiesToSpawn

WeightedCollectionValue<EntityArchetype> possibleEntitiesToSpawn()

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

Returns:

The immutable weighted entity collection value of entities

See Also:

Keys.SPAWNER_ENTITIES