Changes between Version 5 and Version 6 of Scripting/API

Timestamp:

05/07/23 16:23:46 (12 months ago)

Author:

admin

Comment:

--

Scripting/API

@@ -128 +128 @@
 }}}
 
+== Loading a Map Format ==
+
+To be able to specify the map format of a newly created world you need to obtain a reference to the map format like so:
+
+{{{
+#!js
+var mapFormat = wp.getMapFormat()
+    .withId('id') // Mutually exclusive with withName(). The ID of the map format to obtain
+    .withName('name') // Mutually exclusive with withId(). The name of the map format to obtain
+    .go(); // Returns the map format with the specified ID or name
+}}}
+
+Note that it is recommended to use the ID, as that is guaranteed to be stable, while the names might change from release to release. Here are the IDs of the currently supported map formats of !WorldPainter:
+
+|| {{org.pepsoft.mcregion}} || Minecraft 1.1 (MCRegion) ||
+
 == Creating a World from a Height Map ==
 
@@ -139 +155 @@
     .shift(0, 0) // Optional. The number of blocks the height map should be shifted east and south respectively (negative numbers shift west and north). Default value: 0, 0
     .fromLevels(0, 255).toLevels(0, 255) // Optional. Specifies how image values should be mapped to surface heights. The first two values are the lower and upper bounds of the range of image values; the second pair of values if the corresponding range of surface heights those image values should be mapped to. The default is to map the values one on one
+    .withWaterLevel(62) // Optional. The default water level to set the new world to. Default value: 62
+    .withMapFormat(mapFormat) // Optional. The map format to set the new world to. See below for obtaining the reference to the map format. Defaults to the default map format configured in the !WorldPainter Preferences
+    .withLowerBuildLimit(-64) // Optional. The lower build limit to set the new world to. This value is inclusive. Defaults to the default lower build limit of the map format
+    .withUpperBuildLimit(320) // Optional. The upper build limit to set the new world to. This valus is exclusive. Defaults to the default upper build limit of the map format
     .go(); // Returns the created world for exporting, saving or using in other operations
 }}}