Changes between Version 33 and Version 34 of Rmgen_Library

Timestamp:

Dec 11, 2012, 12:11:54 AM (11 years ago)

Author:

historic_bruno

Comment:

Adds some links

Rmgen_Library

@@ -9 +9 @@
 To simplify terrain texture placement the axis (including height) are scaled to tiles with a tile granting the space used to place a terrain texture (One tile = 4.0 model-space units that are used in the engine). While placing a terrain texture is only allowed on a tile (defined by integer coordinates) entities for example can be placed anywhere on the map (float coordinates). Note that a terrain texture on 0/0 is placed on the square from 0/0 to 1/1 so an entity placed at 0.5/0.5 would be in the middle of that terrain texture.
 
-Before the random map is saved the coordinates and angles are converted to the 3D behavior of the engine (see getMapData in map.js).
+Before the random map is saved the coordinates and angles are converted to the 3D behavior of the engine (see `getMapData()` in [source:ps/trunk/binaries/data/mods/public/maps/random/rmgen/map.js map.js]).
 
 == Terrains ==
@@ -15 +15 @@
 The concept of terrains in rmgen is more than just textures that are painted onto a tile. As part of the terrain, a tile can also have objects on it that are "attached" to the terrain and hence removed when the tile is painted with a different terrain (for example, if you paint a forest and then paint a patch of desert inside of it, there will be no trees on the desert). Furthermore, API functions that require terrains can also take a number of complex objects that might paint different tiles with different textures but still make up one type of "logical terrain" (for example, something that paints mixed types of dirt for variation). The following ways of specifying a terrain are available:
 
- * Specify a texture name. Valid textures are dds files which can be found in `/art/textures/terrain/types/`. One example of such a texture is `"medit_grass_field_dry"` from the Mediterranean biome.
- * Specify a texture name and tree type to paint a forest. Tree types are specified in xml files in `/simulation/templates/gaia`. The texture and tree are combined one string, separate by a pipe character "|". For example, use `"medit_grass_wild|gaia/flora_tree_euro_beech"` to paint Mediterranean wild grass and beech trees.
+ * Specify a texture name. Valid textures are dds files which can be found in [source:ps/trunk/binaries/data/mods/public/art/textures/terrain/types /art/textures/terrain/types]. One example of such a texture is `"medit_grass_field_dry"` from the Mediterranean biome.
+ * Specify a texture name and tree type to paint a forest. Tree types are specified in xml files in [source:ps/trunk/binaries/data/mods/public/simulation/templates/gaia /simulation/templates/gaia]. The texture and tree are combined one string, separate by a pipe character "|". For example, use `"medit_grass_wild|gaia/flora_tree_euro_beech"` to paint Mediterranean wild grass and beech trees.
  * Specify an array with any combination of the above methods, which will be randomly chosen for each tile. For example, `["medit_grass_wild|gaia/flora_tree_euro_beech", "medit_grass_field_dry"]` would paint either grassy forest or a dry field.
 
@@ -86 +86 @@
 === Area painters ===
 
-The following area painters are available. Remember that terrains can be any of the objects in the "A Note on Terrains" section above.
+The following area painters are available. Remember that terrains can be any of the objects in the [#Terrains terrains] section above.
 
 An area can also be painted with ''multiple'' painters in sequence by specifying an array of area painters as the painter argument. For example, specify `[new TerrainPainter("snow"), new ElevationPainter(4.0)]` to paint an area with snow and also raise it to height 4.
@@ -99 +99 @@
 == Placing Units: Object Groups ==
 
-An ''object'' or ''entity'' is the game's representation of various units, buildings, and props that occur on a map. You can place objects in a similar way to painting terrains by using ''object groups''. An object group is one or more types of objects which can be placed according to an optional constraint. This process is analogous to creating an area, but it doesn't modify the terrain.
+An ''object'' or [wiki:Entity entity] is the game's representation of various units, buildings, and props that occur on a map. You can place objects in a similar way to painting terrains by using ''object groups''. An object group is one or more types of objects which can be placed according to an optional constraint. This process is analogous to creating an area, but it doesn't modify the terrain.
 
 Currently there is one way to specify a type of object, `SimpleObject(type, minCount, maxCount, minDistance, maxDistance, minAngle, maxAngle)`:
- * '''type''': This is the name of an entity's XML file, which can be found under `/simulation/templates/`. An example type of entity is `"/structures/hele_civil_centre"`. Note that entities are often prefixed with a civilization identifier.
+ * '''type''': This is the name of an entity's XML file, which can be found under [source:ps/trunk/binaries/data/mods/public/simulation/templates/ /simulation/templates/]. An example type of entity is `"/structures/hele_civil_centre"`. Note that entities are often prefixed with a civilization identifier.
  * '''minCount''', '''maxCount''': The number of objects to place.
  * '''minDistance''', '''maxDistance''': The distance between placed objects.
@@ -189 +189 @@
  * `getNumPlayers()`: Returns number of players.
  * `getCivCode(player)`: Returns the 4-character civ code of the given player.
- * `getStartingEntities(player)`: Returns an array of civ-specific starting entity objects, as defined in `/civs/*.json`. Each object has a `Template` and an optional `Count` property. The first entry is usually the civ centre.
+ * `getStartingEntities(player)`: Returns an array of civ-specific starting entity objects, as defined in [source:ps/trunk/binaries/data/mods/public/civs /civs/*.json]. Each object has a `Template` and an optional `Count` property. The first entry is usually the civ centre.
  * `isCircularMap()`: Returns true if the map is circular.
 
@@ -275 +275 @@
 == Script Library ==
 
-These are the scripts that are part of the rmgen library:
+These are the scripts that are part of the [source:ps/trunk/binaries/data/mods/public/maps/random/rmgen rmgen library]:
  * '''area.js''': Defines area data structure
  * '''constraint.js''': Defines constraints