Changes between Version 6 and Version 7 of Random_Map_Generator_Internals

Timestamp:

Jul 9, 2011, 2:31:07 AM (13 years ago)

Author:

historic_bruno

Comment:

adds table of contents and format corrections

Random_Map_Generator_Internals

@@ +1 @@
+[[TOC]]
 For Alpha 5, there will be a random map generator integrated with the engine. This document describes the interaction between the engine and the random map scripts.
 
-= Generating the Map =
+== Generating the Map ==
 
 When loading a scenario, the CMapReader class simply reads an XML file (with map settings, list of entities, and other textual data) together with a binary file called a PMP (which specifies height map and terrain textures). For a random map, there is obviously no predefined map data to load. Instead, the engine uses a new CMapGenerator class. The CMapGenerator needs the name of a random map script and some settings, such as number of players and their civs. These are selected during game setup.
@@ -21 +22 @@
   "seaLevel": 20.0,
   "textureNames": [ "medit_grass_field_a", ... ]
-  "tileData": [ { "idx" : 0x0001, "priority" : 0 }, ... ]
+  "tileData": { "index" : [0, 1, 0, 0, 2, ... ], "priority" : [0, 1, 0, 0, 2, ... ] }
   "entities": [ { "id" : 100, "name" : "units/hele_support_female_citizen", "x" : 102.4, "z" : 64.8, "angle" : 0.86}, ... ]
 }
 }}}
  * `size`: Integer. This is the size of the map in tiles.
- * `height`: Array of 16-bit unsigned integers. This is the height data for each tile of the map.
+ * `height`: Flat array of 16-bit unsigned integers. This is the height data for each tile of the map.
  * `seaLevel`: Float. This is the height of the sea, the value in the heightmap for which all lower terrain will be under water.
  * `textureNames`: Array of strings. This is the terrain textures used. They must be in the order in which they were defined (as they are referenced by tile data).
- * `tileData`: Array of tile descriptor objects. Tile descriptors reference the terrain texture(s) for a given tile.
- * `entities`: Array of entity objects. Entities specify something like a tree, unit, or building in the game.
+ * `tileData`: Object. Contains two flat arrays specifying terrain tile data for the map - see below.
+ * `entities`: Array of entity objects. Entities specify something like a tree, unit, or building in the game - see below.
 
-=== Tile descriptor format ===
+=== Tile Data ===
 {{{
 {
-  "idx" : 8,
-  "priority" : 0
+  "index" : [0, 1, 0, 0, 2, ... ],
+  "priority" : [0, 1, 0, 0, 2, ... ]
 }
 }}}
- * `idx`: Integer. Texture ID to be used (value is referenced from `textureNames` array).
- * `priority`: Integer. Optional priority for texture blending (value of 0 is default). Considering adjacent tiles, the texture with higher priority will be blended on top of the tiles with lower priorities.
+Originally this was an array of tile descriptor objects but the size of the resulting map data was greatly reduced by using two typed arrays. This data does '''not''' need to consider patches, this will all be handed by CMapReader.
+ * `indexes`: Flat array of 16-bit unsigned integers. Texture ID to be used for each tile (value is referenced from `textureNames` array).
+ * `priority`: Flat array of 16-bit unsigned integers. Optional priority for texture blending each tile (value of 0 is default). Considering adjacent tiles, the texture with higher priority will be blended on top of the tiles with lower priorities.
 
 === Entity format ===