com.pixelmonmod.pixelmon.api.spawning.calculators

Interface ISelectionAlgorithm

All Known Implementing Classes:

FlatDistinctAlgorithm, LocationWeightedAlgorithm

public interface ISelectionAlgorithm

Interface for an algorithm used to select spawns from a list of possible spawns.

Created by Hiroku

Method Summary

Modifier and Type	Method and Description
java.util.List<SpawnAction<? extends net.minecraft.entity.Entity>>	calculateSpawnActions(AbstractSpawner spawner, java.util.List<SpawnSet> spawnSets, java.util.List<SpawnLocation> spawnLocations) Calculates a list of SpawnActions from the given SpawnSets and SpawnLocations.
default SpawnInfo	choose(AbstractSpawner spawner, SpawnLocation spawnLocation, java.util.ArrayList<SpawnInfo> spawnInfos) Default method which chooses a SpawnInfo from the given list by percentage if possible, then using normal rarity sum method.
default SpawnInfo	chooseViaPercentage(AbstractSpawner spawner, java.util.ArrayList<SpawnInfo> spawnInfos) Default method that chooses a SpawnInfo from the given list based on the SpawnInfo.percentage if possible.
java.util.Map<SpawnInfo,java.lang.Float>	getAdjustedRarities(AbstractSpawner spawner, java.util.Map<SpawnLocation,java.util.List<SpawnInfo>> possibleSpawns) Gets the adjusted rarities of the given mapping from SpawnLocation to list of SpawnInfos.
default java.util.Map<java.lang.String,java.lang.Double>	getPercentages(AbstractSpawner spawner, java.util.Map<SpawnLocation,java.util.List<SpawnInfo>> possibleSpawns) Default method that converts a mapping of SpawnLocation to list of SpawnInfo into a mapping from label to percentage This calls getAdjustedRarities(AbstractSpawner, Map), which is how this ends up getting implementation-specific results.

Method Detail

calculateSpawnActions

java.util.List<SpawnAction<? extends net.minecraft.entity.Entity>> calculateSpawnActions(AbstractSpawner spawner,
                                                                                         java.util.List<SpawnSet> spawnSets,
                                                                                         java.util.List<SpawnLocation> spawnLocations)

Calculates a list of SpawnActions from the given SpawnSets and SpawnLocations.

getAdjustedRarities

java.util.Map<SpawnInfo,java.lang.Float> getAdjustedRarities(AbstractSpawner spawner,
                                                             java.util.Map<SpawnLocation,java.util.List<SpawnInfo>> possibleSpawns)

Gets the adjusted rarities of the given mapping from SpawnLocation to list of SpawnInfos.

getPercentages

default java.util.Map<java.lang.String,java.lang.Double> getPercentages(AbstractSpawner spawner,
                                                                        java.util.Map<SpawnLocation,java.util.List<SpawnInfo>> possibleSpawns)

Default method that converts a mapping of SpawnLocation to list of SpawnInfo into a mapping from label to percentage This calls getAdjustedRarities(AbstractSpawner, Map), which is how this ends up getting implementation-specific results.

chooseViaPercentage

@Nullable
default SpawnInfo chooseViaPercentage(AbstractSpawner spawner,
                                                java.util.ArrayList<SpawnInfo> spawnInfos)

Default method that chooses a SpawnInfo from the given list based on the SpawnInfo.percentage if possible.

choose

default SpawnInfo choose(AbstractSpawner spawner,
                         SpawnLocation spawnLocation,
                         java.util.ArrayList<SpawnInfo> spawnInfos)

Default method which chooses a SpawnInfo from the given list by percentage if possible, then using normal rarity sum method.