Changes between Version 26 and Version 27 of Rmgen_Library

Timestamp:

May 10, 2012, 1:15:52 PM (12 years ago)

Author:

FeXoR

Comment:

Adjusted "Placing walls" to recent changes

Rmgen_Library

@@ -155 +155 @@
 
 The functions and data provided in wall_builder.js allow easy placements of multiple entities to shape walls. Fist some concepts used:
- * The 'wall style' is chosen by a wall style string for example like the civ strings ('cart' or 'celt') or other descriptive strings ('palisades' or 'romeSiege').
+ * The "wall style" is chosen by a wall style string for example like the civ strings ("cart" or "celt") or other descriptive strings ("palisades" or "rome_siege"). 
  * To provide easy placement of fortresses there are some predefined 'fortresses' commonly chosen by a string describing their size (like map sizes) for example 'tiny' or 'veryLarge'.
- * 'Wall elements' are commonly chosen by strings like 'wall', 'tower', 'gate' etc. (see WallElement class definition for more documentation).
- * Wall elements are merged in an array that then defines a 'wall' or a 'wall part'. Those walls can then be placed with the functions.
+ * 'Wall elements' are commonly chosen by strings like 'wall', 'tower', 'gate' etc. (see `WallElement` class definition for more documentation).
+ * Wall element type strings are merged in an array that then defines a 'wall' or a 'wall part'. Those walls can then be placed with the functions.
+ * As far as possible (as will be, not as is) wall style and wall element type strings are chosen to fit the entity name "prefix" and "suffix" so that the entities used for this style can be got by: "structures/" + wallStyleString + "_" + wallElementTypeString.
 The most simple placement methods are:
- * 'placeFortress()': Places a default fortress by it's fortress name string centered at the given coordinates with its entrance facing 'orientation'.
- * 'placeLinearWall()': Places a wall from start X/Y to target X/Y with repeated usage of the given 'wall part'.
- * 'placeCircularWall()': Places a wall circle centered at the given coordinates with a given radius and repeated usage of the given 'wall part'.
- * 'placeWall()': Function to place a simple wall defined by a 'wall' array starting with the first wall element placed as given by coordinates and angle.
+ * `placeFortress()`: Places a default fortress by it's fortress name string centered at the given coordinates with its entrance facing "orientation".
+ * `placeLinearWall()`: Places a wall from start X/Y to target X/Y with repeated usage of the given "wall part".
+ * `placeCircularWall()`: Places a wall circle centered at the given coordinates with a given radius and repeated usage of the given "wall part".
+ * `placePolygonalWall()`: Places n walls of the same length with the corners on a circle of the given radius centered at the given coordinates.
+ * `placeIrregularPolygonalWall()`: Places n walls of random length with the corners on a circle of the given radius centered at the given coordinates.
+ * `placeGenericFortress()`: Place a more generic looking wall around a point (like the Iberian civ bonus) centered at the given coordinates (Work In Progress).
+ * `placeWall()`: Function to place a simple wall defined by a "wall" array starting with the first wall element placed as given by coordinates and angle.
 Other functions are in there helpful to generate custom walls and fortresses:
- * 'WallElement()': Defines a wall element including its entity and a name string to easily access it.
- * 'Fortress()': Defines a fortress mainly by its 'wall' and a name string to easily access it.
- * 'wallStyles': An associative array that holds all default wall styles with the civ strings as keys (like 'cart' or 'celt') or other descriptive strings (like 'palisades' or 'romeSiege'). A wall style itself again is an associative array holding all the default wall elements with their name string as key (like 'wall' or 'tower').
- * 'fortressTypes': An associative array that holds all default fortress types by a key that is mainly chosen like the map sizes (like 'tiny' or 'veryLarge').
- * 'getWallAlignment()': A function to get a walls 'alignment' that mainly includes everything needed to place all the wall's elements.
- * 'getWallCenter()': A function to get the 'center of mass' of a wall by giving its 'alignment' and returning the vector from the first element to the center.
+ * `WallElement()`: Defines a wall element including its entity and a name string to easily access it.
+ * `Fortress()`: Defines a fortress mainly by its "wall" and a name string to easily access it.
+ * `wallStyles`: An associative array that holds all default wall styles with the civ strings as keys (like "cart" or "celt") or other descriptive strings (like "palisades" or "rome_siege"). A wall style itself again is an associative array holding all the default wall elements with their name string as key (like "wall" or "tower").
+ * `fortressTypes`: An associative array that holds all default fortress types by a key that is mainly chosen like the map sizes (like "tiny" or "veryLarge").
+ * `getWallAlignment()`: A function to get a walls "alignment" that mainly includes everything needed to place all the wall's elements.
+ * `getWallCenter()`: A function to get the "center of mass" of a wall by giving its "alignment" and returning the vector from the first element to the center.
+ * `getWallLength()`: A function to get the length of a wall or wall part with no overlapping. This doesn't support bending wall elements (see below).
 Examples:
-- To see examples for the common methods look at the demo random map 'Wall Demo' (wall_demo.js).
-- An example for placing a custom fortress can be found in 'Fortress' (fortress.js).
+- To see examples for the common methods look at the demo random map "Wall Demo" (wall_demo.js).
+- An example for placing a custom fortress can be found in the random map "Fortress" (fortress.js).
+Notes:
+- Only `placeFortress()`, `placeWall()` and `getWallAlignment()` support wall elements with bending (like "cornerIn", and "cornerOut").
 
 == Map Helpers ==