twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-11 10:12:06 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add example to WorldCreator.generatorSettings documentation.

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2020-01-07 16:46:01 +11:00
parent 5c8af7e9b3
commit 258209b485
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -229,9 +229,15 @@ public class WorldCreator {
} }
/** /**
* Sets the generator settings of the world that will be created or loaded * 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>
* *
* @param generatorSettings The settings that should be used by the generator * @param generatorSettings The settings that should be used by the
* generator
* @return This object, for chaining * @return This object, for chaining
*/ */
@NotNull @NotNull
@@ -242,9 +248,10 @@ public class WorldCreator {
} }
/** /**
* Gets the generator settings of the world that will be created or loaded * Gets the generator settings of the world that will be created or loaded.
* *
* @return The settings that should be used by the generator * @return The settings that should be used by the generator
* @see #generatorSettings(java.lang.String)
*/ */
@NotNull @NotNull
public String generatorSettings() { public String generatorSettings() {