Changes between Version 5 and Version 6 of Development/FileFormatsExplained

Timestamp:

09/25/09 20:59:52 (10 years ago)

Author:

ibboard

Comment:

--

Development/FileFormatsExplained

@@ -22 +22 @@
 == Races ==
 
-Race files define the units and equipment that can be taken in an army of a given race. Each race must be part of a game system and each army must be of a race.
+The [browser:IBBoard.WarFoundry.API/trunk/dtds/race.xsd Race schema] defines the structure of the race files. Race files define the units and equipment that can be taken in an army of a given race. Each race must be part of a game system and each army must be of a race.
 
 === <race> ===
@@ -45 +45 @@
  * {{{minNum}}}/{{{maxNum}}} - the minimum and maximum number of times an item can be taken by each instance of the unit
  * {{{minPercentage}}}/{{{maxPercentage}}} - the minimum and maximum percentage of the unit who can be equiped with the item
- * More detail soon...
+ * {{{roundDirection}}} - defines whether to round the number of items taken up or down if a min/maxPercentage limit for a unit doesn't reach a whole number (which is likely to be a common occurrence). Used in situations such as Lord of the Rings where "up to one third of the unit, rounding up, can take bows".
+ * {{{costMultiplier}}} - the multiplier of the base price for the equipment item. Useful to allow units to get equipment (e.g. swords) for free but charge champions the full price, or where a unit type (e.g. goblins) get the equipment for half-price.
+ * {{{costRounding}}} - how to round any fractions of prices for the total cost of the equipment (especially when multipliers are in place). Can be up, down, [http://en.wikipedia.org/wiki/Rounding#Round_half_to_even Banker's rounding] (rounding to the closest whole with a bias towards the even number for halves), up to a half, down to a half, or 'Banker's half rounding' (rounding to the closest half with a bias towards the whole for quarter values)
 
-=== Rest... ===
+==== <unitAbilities> and <unitAbility> ====
 
-More detail to come...
+The {{{<unitAbilities>}}} tag is a container for {{{<unitAbility>}}} tags. unitAbility tags define which abilities/skills a unit has. As of 25th September 2009 they are loaded by the API but not used in the UI. Each unitAbility has the following attributes:
+
+ * {{{abilityID}}} - a reference to the ID of the ability defined later in the file
+ * {{{required}}} - a boolean that determines whether the ability is always taken by the unit (an innate ability) or whether it is optional (a training/doctrine)
+
+==== <requirements> ====
+
+Currently unused. The requirements will define data that is used to trigger requirement calculations.
+
+==== <contains> and <containedUnit> ====
+
+Currently loaded but unused. Allows a unit to define units that it "contains", either champions (who are sometimes separate entities, but are part of the unit) or to represent detachments and sub-units.
+
+==== <extraData> and <data> ====
+
+Currently unused, but useful for a variety of purposes. Can contain additional notes (e.g. design text) or data used by requirement calculations.
+
+=== <categories> ===
+
+Overrides the default categories from the game system. The definition is the same as for the game system.
+
+=== <equipment> and <equipmentItem> ===
+
+The {{{<equipment>}}} tag is a container for {{{<equipmentItem>}}} tags. The equipmentItem tags define the equipment available to the race as a whole. Units reference the equipment items through unitEquipmentItem tags. Attributes of the equipmentItem are:
+
+ * {{{id}}} - the unique ID of the equipment item
+ * {{{name}}} - the name of the equipment item
+ * {{{cost}}} - the normal points cost of the equipment item (may be modified by the unitEquipmentItem's costMultiplier)
+ * {{{armourType}}} - the type of "armour" that the equipment is. Defaults to "none", but covers all combinations of 'light' armour and 'heavy' armour (with the latter being an upgrade of the former), shields (which can be taken with armour) and mount armour or "barding". These types don't need to be taken literally, but give a way of defining what "armour" equipment can be combined together.
+
+=== <abilities> and <ability> ===
+
+The {{{<abilities>}}} tag is a container for {{{<ability>}}} tags. The ability tags define the abilities/skills available to the race as a whole. Units reference the abilities through unitAbility tags. Attributes of the ability are:
+ * {{{id}}} - the unique ID of the ability
+ * {{{name}}} - the name of the ability
+Details of the ability should be known by the user and available in the appropriate army definition
 
 == Armies ==