Difference between revisions of "Better Spawner/Config"
(Created the page, incomplete) |
(Completed) |
||
Line 1: | Line 1: | ||
− | The Better Spawner Config is a special config located | + | The Better Spawner Config is a special config located at <code>./config/pixelmon/BetterSpawnerConfig.json</code>. It is used for more advanced configuration of the Better Spawner's behaviour. |
− | + | == Properties: == | |
+ | ---- | ||
+ | <code>"globalCompositeCondition"</code> | ||
+ | |||
+ | The global composite condition is a [[Better_Spawner/Composite_Condition|composite condition]] that is applied to all [[Better_Spawner/Spawn_Info|SpawnInfo]] of all types. There are many applications for this, such as creating areas where nothing can spawn, or making particular dimensions only spawn entities during a full moon, to name just two. As an example, the following is how to do both of the above: | ||
+ | <div onload="prettyPrint()"> | ||
+ | <pre class="prettyprint"> | ||
+ | "globalCompositeCondition": { | ||
+ | "conditions": [ | ||
+ | { | ||
+ | "dimensions": [ | ||
+ | 0 | ||
+ | ] | ||
+ | }, | ||
+ | { | ||
+ | "dimensions": [ | ||
+ | 1 | ||
+ | ], | ||
+ | "moonPhase": 0 | ||
+ | } | ||
+ | ], | ||
+ | "anticonditions": [ | ||
+ | { | ||
+ | "minX": 50, | ||
+ | "maxX": 120, | ||
+ | "minZ": 0, | ||
+ | "maxZ": 200, | ||
+ | "dimensions": [ | ||
+ | 0 | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | </pre> | ||
+ | </div> | ||
+ | By default the global composite condition will be a simple restriction such that spawning only occurs in the Overworld. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | <code>"intervalSeconds"</code> | ||
+ | |||
+ | The interval seconds are used to guarantee particular kinds of spawns cannot happen too often in a window of time. A [[Better_Spawner/Spawn_Info|SpawnInfo]] might have the property <code>"interval": "legendary"</code>, in which case when it is about to spawn it will stop if another entity with that interval has spawned recently. This property is to specify how long "recently" is. To make legendary Pokémon spawn at least 2 hours apart, the following could be used for the interval seconds property (noting that 7200 seconds is 2 hours): | ||
+ | <div onload="prettyPrint()"> | ||
+ | <pre class="prettyprint"> | ||
+ | "intervalSeconds": { | ||
+ | "legendary": 7200 | ||
+ | }, | ||
+ | </pre> | ||
+ | </div> | ||
+ | |||
+ | The interval restriction affects [[Better_Spawner/Supported|everything that uses the Better Spawner]]. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | <code>"blockCategories"</code> | ||
+ | |||
+ | The block categories are a type of [[Better_Spawner/Categories|category]] used for several [[Better_Spawner/Location_Type|LocationTypes]] and in the <code>baseBlocks</code> and <code>neededNearbyBlocks</code> properties of [[Better_Spawner/Spawn_Condition|SpawnConditions]]. More on categories can be read [[Better_Spawner/Categories|here]]. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | <code>"biomeCategories"</code> | ||
+ | |||
+ | The biome categories are a type of [[Better_Spawner/Categories|category]] used in the <code>stringBiomes</code> property of [[Better_Spawner/Spawn_Condition|SpawnConditions]] and in world generation in one special case. The <code>"all forests"</code> biome category is the only one strictly necessary as [[Hidden Grotto]] world generation checks this category to know where to generate these. More on categories can be read [[Better_Spawner/Categories|here]]. |
Revision as of 04:44, 4 June 2018
The Better Spawner Config is a special config located at ./config/pixelmon/BetterSpawnerConfig.json
. It is used for more advanced configuration of the Better Spawner's behaviour.
Properties:
"globalCompositeCondition"
The global composite condition is a composite condition that is applied to all SpawnInfo of all types. There are many applications for this, such as creating areas where nothing can spawn, or making particular dimensions only spawn entities during a full moon, to name just two. As an example, the following is how to do both of the above:
"globalCompositeCondition": { "conditions": [ { "dimensions": [ 0 ] }, { "dimensions": [ 1 ], "moonPhase": 0 } ], "anticonditions": [ { "minX": 50, "maxX": 120, "minZ": 0, "maxZ": 200, "dimensions": [ 0 ] } ] },
By default the global composite condition will be a simple restriction such that spawning only occurs in the Overworld.
"intervalSeconds"
The interval seconds are used to guarantee particular kinds of spawns cannot happen too often in a window of time. A SpawnInfo might have the property "interval": "legendary"
, in which case when it is about to spawn it will stop if another entity with that interval has spawned recently. This property is to specify how long "recently" is. To make legendary Pokémon spawn at least 2 hours apart, the following could be used for the interval seconds property (noting that 7200 seconds is 2 hours):
"intervalSeconds": { "legendary": 7200 },
The interval restriction affects everything that uses the Better Spawner.
"blockCategories"
The block categories are a type of category used for several LocationTypes and in the baseBlocks
and neededNearbyBlocks
properties of SpawnConditions. More on categories can be read here.
"biomeCategories"
The biome categories are a type of category used in the stringBiomes
property of SpawnConditions and in world generation in one special case. The "all forests"
biome category is the only one strictly necessary as Hidden Grotto world generation checks this category to know where to generate these. More on categories can be read here.