Changes between Version 17 and Version 18 of Random_Map_Generator

Timestamp:

05/28/24 21:03:30 (3 months ago)

Author:

phosit

Comment:

Remove "Initialize the library" because of [20995]; convert "Save the results" to "GenerateMap generator" because of [28093]

Random_Map_Generator

@@ -25 +25 @@
 A random map script should first load any libraries it will need. Libraries are stored in the game data directories under `maps/random/libraryName/`. When a library is loaded, all scripts in that directory are parsed and their code made available to the random map script. They are loaded through the function call `Engine.LoadLibrary(libraryName)`.
 
-=== Initialize the library ===
+=== !GenerateMap generator ===
 
-The next step is to initialize the library. This may vary, but for rmgen, you would call `InitMap()`.
-
-=== Save the results ===
-
-The random map script should end with a call to `Engine.ExportMap(data)`, which returns all the map data back to the engine. In rmgen this is abstracted by a call to `ExportMap()`. For the exact format of the data see [wiki:Random_Map_Generator_Internals Random Map Generator Internals].
-
-'''Note:''' The export map function does a coordinate conversion from the 2D used in the rmgen libs to 3D for the engine. You should only use it once, only after the map is fully generated.
+The script has to implement a generator with the name !GenerateMap (like: `function* GenerateMap(mapSettings)`. Normally the whole map computation is done in this function. The function get's the map settings as an argument and has to `return` the map. It can repeatetly `yield` the progress (a number from 1 to 100) to update the progress bar. See [wiki:Random_Map_Generator_Internals Random Map Generator Internals] for more details.
 
 === Design Tips and Conventions ===