org.spongepowered.api.data.manipulator.immutable

Interface ImmutableMobSpawnerData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableMobSpawnerData,MobSpawnerData>, ValueContainer<ImmutableMobSpawnerData>

public interface ImmutableMobSpawnerData
extends ImmutableDataManipulator<ImmutableMobSpawnerData,MobSpawnerData>

An ImmutableDataManipulator for all information surrounding a MobSpawner and MobSpawnerMinecart. The data defined will provide new Entity spawns with varying types and data.

Method Summary

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

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, copy, with, with

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

ImmutableBoundedValue<Short> remainingDelay()

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

Returns:

The immutable bounded value for the remaining delay

minimumSpawnDelay

ImmutableBoundedValue<Short> minimumSpawnDelay()

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

Returns:

The immutable bounded value of the minimum spawn delay

maximumSpawnDelay

ImmutableBoundedValue<Short> maximumSpawnDelay()

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

Returns:

The immutable bounded value of the maximum spawn delay

spawnCount

ImmutableBoundedValue<Short> spawnCount()

Gets the ImmutableBoundedValue 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

ImmutableBoundedValue<Short> maximumNearbyEntities()

Gets the ImmutableBoundedValue 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 immutable value of the maximum supported nearby entities

requiredPlayerRange

ImmutableBoundedValue<Short> requiredPlayerRange()

Gets the ImmutableBoundedValue 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 immutable value of the required player range to spawn entities

spawnRange

ImmutableBoundedValue<Short> spawnRange()

Gets the ImmutableBoundedValue 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

ImmutableValue<WeightedSerializableObject<EntityArchetype>> nextEntityToSpawn()

Gets the ImmutableValue 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

possibleEntitiesToSpawn

ImmutableWeightedCollectionValue<EntityArchetype> possibleEntitiesToSpawn()

Gets the ImmutableWeightedCollectionValue of all possible Entity instances that can be spawned by the spawner. As they are all WeightedSerializableObject 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