SpawningConfig (Pixelmon 1.16.5-9.1.13-pipe25692 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.config.api.yaml.AbstractYamlConfig
- - com.pixelmonmod.pixelmon.api.config.SpawningConfig

All Implemented Interfaces:: Config

@ConfigSerializable
public class SpawningConfig
extends AbstractYamlConfig

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpawningConfig.BossSpawning`
`static class`	`SpawningConfig.LevelDistance`
`static class`	`SpawningConfig.PokeLoot`
`static class`	`SpawningConfig.PokeStop`
`static class`	`SpawningConfig.WildSpawning`

Field Summary
- Fields inherited from class com.pixelmonmod.pixelmon.api.config.api.yaml.AbstractYamlConfig
  base, config

Constructor Summary

Constructors
Constructor and Description

SpawningConfig()

Constructors
Constructor and Description
`SpawningConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`allGenerationsDisabled()` Checks if all Generations are disabled.
`boolean`	`allGenerationsEnabled()` Checks if all Generations are enabled.
`int`	`getBellInclusionRange()`
`double`	`getBellSuccessChance()`
`java.util.List<java.lang.Integer>`	`getBlockedGenerations()`
`SpawningConfig.BossSpawning`	`getBossSpawning()`
`java.util.List<java.lang.String>`	`getCanTransformToDittoOnCatch()`
`int`	`getCaveMaxMultiplier()`
`int`	`getDespawnRadius()`
`float`	`getGigantamaxFactorRate()`
`float`	`getGigantamaxFactorRate(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)`
`float`	`getHiddenAbilityRate()` Deprecated.
`float`	`getHiddenAbilityRate(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)` Deprecated.
`int`	`getLegendaryDespawnTicks()`
`float`	`getLegendarySpawnChance()`
`int`	`getLegendarySpawnTicks()`
`SpawningConfig.LevelDistance`	`getLevelDistance()`
`int`	`getLureFluteDuration()`
`int`	`getLureFluteLevelModifier()`
`long`	`getMeltanBoxCooldownDurationMillis()`
`int`	`getMeltanBoxInitialScrapsCount()`
`long`	`getMeltanBoxOpenDurationMillis()`
`double`	`getMeltanBoxScrapsMultiplier()`
`int`	`getMeltanBoxSpawnRadius()`
`int`	`getMeltanBoxSpawnRate()`
`double`	`getMeltanTransformChance()`
`int`	`getPlayerTrackingSpawnerSpawnCollectionRate()`
`SpawningConfig.PokeLoot`	`getPokeLoot()`
`SpawningConfig.PokeStop`	`getPokeStop()`
`int`	`getRandomEnabledGeneration()`
`float`	`getShinyCharmMultiplier()`
`float`	`getShinyRate()`
`float`	`getShinyRate(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)`
`float`	`getSpawnTicksPlayerMultiplier()`
`double`	`getTransformToDittoOnCatch()`
`float`	`getUltraSpaceHordeSpawnRate()`
`double`	`getUltraSpaceLevelMultiplier()`
`SpawningConfig.WildSpawning`	`getWildSpawning()`
`boolean`	`isAllowLegendarySpawn()`
`boolean`	`isAlwaysAggressiveDimensions(net.minecraft.world.World world)`
`boolean`	`isDespawnOnFleeOrLoss()`
`boolean`	`isDisplayLegendaryGlobalMessage()`
`boolean`	`isDoLegendaryRaidEvent()`
`boolean`	`isGenerationEnabled(int generation)` Checks if a certain Generation is enabled.
`boolean`	`isHordeBattleDimensions(net.minecraft.world.World world)`
`boolean`	`isSpawningDisabledDimension(net.minecraft.world.World world)`
`boolean`	`isSpawnLevelsCloserToPlayerLevels()`
`boolean`	`isSpawnLevelsIncreaseInCaves()`
`boolean`	`isSpawnLevelsIncreaseInUltraSpace()`
`boolean`	`isSpawnZygardeCells()`
`boolean`	`isUseRecentLevelMoves()`
`boolean`	`shouldHaveHiddenAbility(float rate)`
`boolean`	`shouldHaveHiddenAbility(Stats form, net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)`

Methods inherited from class com.pixelmonmod.pixelmon.api.config.api.yaml.AbstractYamlConfig
getNode, save

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpawningConfig
```
public SpawningConfig()
```
- Method Detail
  - getDespawnRadius
```
public int getDespawnRadius()
```
    Returns:
    
    The minimum number of blocks away from the nearest player a Pokémon can be when despawned.
  - getShinyRate
```
public float getShinyRate()
```
    Returns:
    
    The chance of a Pokémon being Shiny.
  - getShinyCharmMultiplier
```
public float getShinyCharmMultiplier()
```
    Returns:
    
    The multiplier by which to multiply the shiny chance if the player has the shiny charm.
  - getShinyRate
```
public float getShinyRate(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)
```
    Parameters:
    
    dimension - The dimension for the chance
    
    Returns:
    
    The chance of a Pokémon being Shiny.
  - getLegendarySpawnTicks
```
public int getLegendarySpawnTicks()
```
    Returns:
    
    Ticks before a Legendary Pokémon will attempt to spawn.
  - getLegendarySpawnChance
```
public float getLegendarySpawnChance()
```
    Returns:
    
    Chance that a Legendary Pokémon spawn attempt will succeed. Use
  - getSpawnTicksPlayerMultiplier
```
public float getSpawnTicksPlayerMultiplier()
```
    Returns:
    
    The multiplier applied to spawn ticks for legendary and boss spawning in the equation: ticks = defaultTicks / (1 + (numPlayers - 1) * x)
  - isSpawnLevelsCloserToPlayerLevels
```
public boolean isSpawnLevelsCloserToPlayerLevels()
```
    Returns:
    
    Whether or not to tweak levels of wild Pokémon to better suit the player's party.
  - isSpawnLevelsIncreaseInCaves
```
public boolean isSpawnLevelsIncreaseInCaves()
```
    Returns:
    
    Whether or not to tweak levels of wild Pokemon spawning in caves to increase the difficulty
  - getCaveMaxMultiplier
```
public int getCaveMaxMultiplier()
```
    Returns:
    
    Maximum multiplier of the pokemon's pokemonLevel in caves
  - getUltraSpaceLevelMultiplier
```
public double getUltraSpaceLevelMultiplier()
```
    Returns:
    
    The level multiplier on the levels of pokemon spawning in the ultraspace
  - getTransformToDittoOnCatch
```
public double getTransformToDittoOnCatch()
```
    Returns:
    
    Chance for a wild Pokemon to turn into a Ditto on capture.
  - getMeltanTransformChance
```
public double getMeltanTransformChance()
```
    Returns:
    
    Chance for Meltan to become a Ditto on catch.
  - getMeltanBoxSpawnRate
```
public int getMeltanBoxSpawnRate()
```
    Returns:
    
    Average ticks until a Meltan spawns from an open Mystery Box.
  - getMeltanBoxSpawnRadius
```
public int getMeltanBoxSpawnRadius()
```
    Returns:
    
    Spawn radius of Meltan from an open Mystery Box.
  - getMeltanBoxInitialScrapsCount
```
public int getMeltanBoxInitialScrapsCount()
```
    Returns:
    
    Initial number of scraps required to open a Mystery Box.
  - getMeltanBoxScrapsMultiplier
```
public double getMeltanBoxScrapsMultiplier()
```
    Returns:
    
    By how much the number of scraps required to open a Mystery Box is multiplied by each time.
  - getMeltanBoxOpenDurationMillis
```
public long getMeltanBoxOpenDurationMillis()
```
    Returns:
    
    How many milliseconds Mystery Boxes are open for.
  - getMeltanBoxCooldownDurationMillis
```
public long getMeltanBoxCooldownDurationMillis()
```
    Returns:
    
    How many milliseconds Mystery Boxes are on cooldown for.
  - getCanTransformToDittoOnCatch
```
public java.util.List<java.lang.String> getCanTransformToDittoOnCatch()
```
    Returns:
    
    Pokemon which can transform to Ditto.
  - getHiddenAbilityRate
```
@Deprecated
public float getHiddenAbilityRate()
```
    Deprecated.
    
    Returns:
    
    Hidden ability spawn rate
  - getHiddenAbilityRate
```
@Deprecated
public float getHiddenAbilityRate(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)
```
    Deprecated.
    
    Parameters:
    
    dimension - The world
    
    Returns:
    
    Hidden ability spawn rate
  - shouldHaveHiddenAbility
```
public boolean shouldHaveHiddenAbility(Stats form,
                                       @Nullable
                                       net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)
```
  - shouldHaveHiddenAbility
```
public boolean shouldHaveHiddenAbility(float rate)
```
  - getGigantamaxFactorRate
```
public float getGigantamaxFactorRate()
```
    Returns:
    
    The chance of a Pokémon having the Gigantamax Factor.
  - getGigantamaxFactorRate
```
public float getGigantamaxFactorRate(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension)
```
    Returns:
    
    The chance of a Pokémon having the Gigantamax Factor.
  - isAllowLegendarySpawn
```
public boolean isAllowLegendarySpawn()
```
    Returns:
    
    Whether Legendary Pokémon can spawn.
  - getLegendaryDespawnTicks
```
public int getLegendaryDespawnTicks()
```
    Returns:
    
    Ticks until a Legendary Pokémon despawns.
  - isDisplayLegendaryGlobalMessage
```
public boolean isDisplayLegendaryGlobalMessage()
```
    Returns:
    
    Whether the Legendary Pokémon spawning message appears.
  - isDoLegendaryRaidEvent
```
public boolean isDoLegendaryRaidEvent()
```
    Returns:
    
    Whether the Legendary Pokémon spawning message appears for raids.
  - isUseRecentLevelMoves
```
public boolean isUseRecentLevelMoves()
```
    Returns:
    
    Whether Pokémon will start with the most recent pokemonLevel-up moves in their pokemonLevel-up movepools.
  - isDespawnOnFleeOrLoss
```
public boolean isDespawnOnFleeOrLoss()
```
    Returns:
    
    Whether wild Pokémon despawn when the battle ends.
  - getBellSuccessChance
```
public double getBellSuccessChance()
```
    Returns:
    
    Chance for a Clear/Tidal bell to succeed.
  - getBellInclusionRange
```
public int getBellInclusionRange()
```
    Returns:
    
    Range where separate bells are considered as part of the same group
  - getLureFluteDuration
```
public int getLureFluteDuration()
```
    Returns:
    
    How long in seconds the effects of Black and White Flutes last. Set to 0 to disable.
  - getLureFluteLevelModifier
```
public int getLureFluteLevelModifier()
```
    Returns:
    
    Up to how many levels the Black and White Flutes can affect spawning by.
  - getBlockedGenerations
```
public java.util.List<java.lang.Integer> getBlockedGenerations()
```
    Returns:
    
    If the list contains a generation flag then it won't spawn naturally
  - isGenerationEnabled
```
public boolean isGenerationEnabled(int generation)
```
    Checks if a certain Generation is enabled.
    
    Parameters:
    
    generation - The Generation to check.
    
    Returns:
    
    Whether the specified Generation is enabled.
  - allGenerationsDisabled
```
public boolean allGenerationsDisabled()
```
    Checks if all Generations are disabled.
    
    Returns:
    
    Whether all Generations are disabled.
  - allGenerationsEnabled
```
public boolean allGenerationsEnabled()
```
    Checks if all Generations are enabled.
    
    Returns:
    
    Whether all Generations are enabled.
  - getRandomEnabledGeneration
```
public int getRandomEnabledGeneration()
```
    Returns:
    
    A random generation from the enabled generations as an integer
    
    Throws:
    
    java.lang.IllegalStateException - when all generations are disabled
  - isSpawnZygardeCells
```
public boolean isSpawnZygardeCells()
```
    Returns:
    
    Whether to spawn Zygarde cells in the world
  - getLevelDistance
```
public SpawningConfig.LevelDistance getLevelDistance()
```
    Returns:
    
    Level distance sub-category
  - getWildSpawning
```
public SpawningConfig.WildSpawning getWildSpawning()
```
    Returns:
    
    Wild spawning sub-category
  - getBossSpawning
```
public SpawningConfig.BossSpawning getBossSpawning()
```
    Returns:
    
    Boss spawning sub-category
  - getPokeLoot
```
public SpawningConfig.PokeLoot getPokeLoot()
```
    Returns:
    
    PokeLoot spawning sub-category
  - getPokeStop
```
public SpawningConfig.PokeStop getPokeStop()
```
    Returns:
    
    PokeStop spawning sub-category
  - isSpawnLevelsIncreaseInUltraSpace
```
public boolean isSpawnLevelsIncreaseInUltraSpace()
```
    Returns:
    
    spawn levels increase in the ultraspace
  - getUltraSpaceHordeSpawnRate
```
public float getUltraSpaceHordeSpawnRate()
```
  - isAlwaysAggressiveDimensions
```
public boolean isAlwaysAggressiveDimensions(net.minecraft.world.World world)
```
  - isHordeBattleDimensions
```
public boolean isHordeBattleDimensions(net.minecraft.world.World world)
```
  - isSpawningDisabledDimension
```
public boolean isSpawningDisabledDimension(net.minecraft.world.World world)
```
  - getPlayerTrackingSpawnerSpawnCollectionRate
```
public int getPlayerTrackingSpawnerSpawnCollectionRate()
```

Class SpawningConfig

Nested Class Summary

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.api.config.api.yaml.AbstractYamlConfig

Constructor Summary

Method Summary

Methods inherited from class com.pixelmonmod.pixelmon.api.config.api.yaml.AbstractYamlConfig

Methods inherited from class java.lang.Object

Constructor Detail

SpawningConfig

Method Detail

getDespawnRadius

getShinyRate

getShinyCharmMultiplier

getShinyRate

getLegendarySpawnTicks

getLegendarySpawnChance

getSpawnTicksPlayerMultiplier

isSpawnLevelsCloserToPlayerLevels

isSpawnLevelsIncreaseInCaves

getCaveMaxMultiplier

getUltraSpaceLevelMultiplier

getTransformToDittoOnCatch

getMeltanTransformChance

getMeltanBoxSpawnRate

getMeltanBoxSpawnRadius

getMeltanBoxInitialScrapsCount

getMeltanBoxScrapsMultiplier

getMeltanBoxOpenDurationMillis

getMeltanBoxCooldownDurationMillis

getCanTransformToDittoOnCatch

getHiddenAbilityRate

getHiddenAbilityRate

shouldHaveHiddenAbility

shouldHaveHiddenAbility

getGigantamaxFactorRate

getGigantamaxFactorRate

isAllowLegendarySpawn

getLegendaryDespawnTicks

isDisplayLegendaryGlobalMessage

isDoLegendaryRaidEvent

isUseRecentLevelMoves

isDespawnOnFleeOrLoss

getBellSuccessChance

getBellInclusionRange

getLureFluteDuration

getLureFluteLevelModifier

getBlockedGenerations

isGenerationEnabled

allGenerationsDisabled

allGenerationsEnabled

getRandomEnabledGeneration

isSpawnZygardeCells

getLevelDistance

getWildSpawning

getBossSpawning

getPokeLoot

getPokeStop

isSpawnLevelsIncreaseInUltraSpace

getUltraSpaceHordeSpawnRate

isAlwaysAggressiveDimensions

isHordeBattleDimensions

isSpawningDisabledDimension

getPlayerTrackingSpawnerSpawnCollectionRate