Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-01 05:47:45 +01:00
Code Issues Projects Releases Wiki Activity

SPIGOT-5970: Update JavaDocs information regarding WorldCreator#generatorSettings

Browse Source 
By: Martoph <sager1018@gmail.com>
This commit is contained in:
Bukkit/Spigot 2020-07-09 08:43:22 +10:00
parent f549bc9e52
commit e7097d04a6
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
paper-api/src/main/java/org/bukkit/WorldCreator.java
View File

@ -232,10 +232,15 @@ public class WorldCreator {
* Sets the generator settings of the world that will be created or loaded.
* <p>
* Currently only {@link WorldType#FLAT} uses these settings, and expects
* them to be in JSON format with a valid biome defined. An example valid
* configuration is as follows:
* <code>{"layers": [{"block": "stone", "height": 1}, {"block": "grass", "height": 1}], "biome":"plains"}</code>
* them to be in JSON format with a valid biome AND structures (1.16 and
* above) defined. Note the occurrence of "structures" twice (nested
* compound may be empty, both must exist.). An example valid configuration
* is as follows:
* <code>{"structures": {"structures": {"village": {"salt": 8015723, "spacing": 32, "separation": 8}}}, "layers": [{"block": "stone", "height": 1}, {"block": "grass", "height": 1}], "biome":"plains"}</code>
*
* @see <a href="https://minecraft.gamepedia.com/Custom_dimension">Custom
* dimension</a> (scroll to "When the generator ID type is
* <code>minecraft:flat</code>)"
* @param generatorSettings The settings that should be used by the
* generator
* @return This object, for chaining