diff --git a/paper-api/src/main/java/org/bukkit/WorldCreator.java b/paper-api/src/main/java/org/bukkit/WorldCreator.java index 5f44526ff6..b562d3792c 100644 --- a/paper-api/src/main/java/org/bukkit/WorldCreator.java +++ b/paper-api/src/main/java/org/bukkit/WorldCreator.java @@ -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. + *
+ * 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:
+ * {"layers": [{"block": "stone", "height": 1}, {"block": "grass", "height": 1}], "biome":"plains"}
*
- * @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
*/
@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
+ * @see #generatorSettings(java.lang.String)
*/
@NotNull
public String generatorSettings() {