com.pixelmonmod.pixelmon.api.spawning

Class SpawnInfo

java.lang.Object

com.pixelmonmod.pixelmon.api.spawning.SpawnInfo

Direct Known Subclasses:

SpawnInfoCollection, SpawnInfoItem, SpawnInfoNPC, SpawnInfoNPCTrainer, SpawnInfoPokemon, SpawnInfoWormhole

public abstract class SpawnInfo
extends java.lang.Object

An outline for a particular spawnable entity. This is what is represented inside SpawnSets and is what SpawnConditions are applied to. Custom implementations are put in the spawnInfoTypes map where the key is the typeID field in the JSONs. If this is done at some time during pre-initialization, SpawnInfos of that custom type will automatically be imported with all subclass fields intact.

For the class members, I'm not going to recreate the wiki, so see the below link to know what each field is.

https://pixelmonmod.com/wiki/index.php?title=Better_Spawner/Spawn_Info

Field Summary

Fields

Modifier and Type	Field and Description
SpawnCondition	anticondition
java.lang.Float	chance
CompositeSpawnCondition	compositeCondition
SpawnCondition	condition
java.util.List<GroupSpawnSettings>	groupSpawnSettings
static com.google.gson.Gson	GSON
java.util.ArrayList<LocationType>	locationTypes The cached list of LocationType used for faster accessing.
java.lang.Float	percentage
float	rarity
java.util.ArrayList<RarityMultiplier>	rarityMultipliers
int	requiredSpace Required diameter of the spawn location.
SpawnSet	set The cached SpawnSet that this SpawnInfo belongs to.
static java.util.HashMap<java.lang.String,java.lang.Class<? extends SpawnInfo>>	spawnInfoTypes A mapping from typeID to SpawnInfo subclass.
java.util.ArrayList<java.lang.String>	stringLocationTypes
java.util.ArrayList<java.lang.String>	tags
java.lang.String	typeID The ID for the type of SpawnInfo this is.

Constructor Summary

Constructors

Constructor and Description
SpawnInfo(java.lang.String typeID)

Method Summary

Modifier and Type	Method and Description
float	calculateNominalRarity() Attempts to calculate the nominal rarity of this spawn.
abstract SpawnAction<? extends net.minecraft.entity.Entity>	construct(AbstractSpawner spawner, SpawnLocation spawnLocation) Constructs a SpawnAction based on the information in this SpawnInfo, the AbstractSpawner, and the SpawnLocation.
boolean	fits(AbstractSpawner spawner, SpawnLocation spawnLocation) Calculates if this SpawnInfo is capable of spawning at the given location.
float	getAdjustedRarity(AbstractSpawner spawner, SpawnLocation spawnLocation) Gets the adjusted rarity of this spawn at this SpawnLocation by applying any RarityMultipliers that exist.
void	onExport()
void	onImport()
abstract java.lang.String	toString() Gets the display String for use in /checkspawns.

Methods inherited from class java.lang.Object

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

Field Detail

GSON

public static final com.google.gson.Gson GSON

spawnInfoTypes

public static java.util.HashMap<java.lang.String,java.lang.Class<? extends SpawnInfo>> spawnInfoTypes

A mapping from typeID to SpawnInfo subclass. Add to this during pre-initialization to have custom SpawnInfo.

typeID

public java.lang.String typeID

The ID for the type of SpawnInfo this is. This is used for deserialization. See spawnInfoTypes.

tags

public java.util.ArrayList<java.lang.String> tags

condition

public SpawnCondition condition

anticondition

public SpawnCondition anticondition

compositeCondition

public CompositeSpawnCondition compositeCondition

rarityMultipliers

public java.util.ArrayList<RarityMultiplier> rarityMultipliers

requiredSpace

public int requiredSpace

Required diameter of the spawn location.

set

public transient SpawnSet set

The cached SpawnSet that this SpawnInfo belongs to.

rarity

public float rarity

percentage

public java.lang.Float percentage

chance

public java.lang.Float chance

locationTypes

public transient java.util.ArrayList<LocationType> locationTypes

The cached list of LocationType used for faster accessing.

stringLocationTypes

public java.util.ArrayList<java.lang.String> stringLocationTypes

groupSpawnSettings

public java.util.List<GroupSpawnSettings> groupSpawnSettings

Constructor Detail

SpawnInfo

public SpawnInfo(java.lang.String typeID)

Method Detail

construct

public abstract SpawnAction<? extends net.minecraft.entity.Entity> construct(AbstractSpawner spawner,
                                                                             SpawnLocation spawnLocation)

Constructs a SpawnAction based on the information in this SpawnInfo, the AbstractSpawner, and the SpawnLocation.

fits

public boolean fits(AbstractSpawner spawner,
                    SpawnLocation spawnLocation)

Calculates if this SpawnInfo is capable of spawning at the given location.

onExport

public void onExport()

onImport

public void onImport()

getAdjustedRarity

public float getAdjustedRarity(AbstractSpawner spawner,
                               SpawnLocation spawnLocation)

Gets the adjusted rarity of this spawn at this SpawnLocation by applying any RarityMultipliers that exist.

toString

public abstract java.lang.String toString()

Gets the display String for use in /checkspawns.

Overrides:

toString in class java.lang.Object

calculateNominalRarity

public float calculateNominalRarity()

Attempts to calculate the nominal rarity of this spawn. This tries to take into account the biomes, times, weather, and normal rarity to find a number that describes the rarity better. This is used for situations wherein a spawn might be very common but only under extremely specific circumstances. In such cases, the rarity number would most likely be very high, despite in actuality the spawn being incredibly rare. This calculation aims to take all those conditions into consideration to give an impression of the rarity.