Changes between Version 7 and Version 8 of Development/FileFormatsExplained


Ignore:
Timestamp:
11/01/09 21:00:33 (10 years ago)
Author:
ibboard
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/FileFormatsExplained

    v7 v8  
    4949==== <equipmentSlots> and <equipmentSlot> ====
    5050
    51 A new feature that is currently in development (ticket:198). Equipment slots represent the additional limited "special equipment" slots that a unit has, such as heavy weapons in Warhammer 40,000. These slots define limited groups of equipment at a finer level of granularity than mutex groups and can be combined with mutex groups for even more powerful combinations/restrictions.
     51A new feature that was released in v0.1b4. Equipment slots represent the additional limited "special equipment" slots that a unit has, such as heavy weapons in Warhammer 40,000 (e.g. "may have up to three heavy guns, assault guns or flamers, or any combination thereof"). These slots define limited groups of equipment at a finer level of granularity than mutex groups and can be combined with mutex groups for even more powerful combinations/restrictions. Equipment slots can also be used with standard equipment limits for more detailed combinations (e.g. the slot may allow up to five items, but if there are three types of equipment in that slot with an item limit of three then the unit can take up to three of one item and two of another, or three of one item and one each of the other two, two of two items and one of the third, or any other combination that doesn't exceed three for each item and five in total). 
    5252
    53 The {{{<equipmentSlots>}}} tag is a container for {{{<equipmentSlot>}}} tags. equipmentSlot tags currently define a name, limit number and limit type. The type is either an absolute number (e.g. "3") or the numerical part of a percentage (e.g. "50" for 50% with {{{isPercentage="true"}}}). If {{{isPercentage}}} isn't defined then an absolute number is assumed.
     53The {{{<equipmentSlots>}}} tag is a container for {{{<equipmentSlot>}}} tags. equipmentSlot tags contain a {{{<maxLimit>}}} tag, which just acts as a container for one of the specific limit tags.
     54
     55===== Limits =====
     56
     57Equipment slots can currently have one of four limit types, some of which are more useful than others for equipment slots. Note that as these limits are centrally defined then an extra namespace is required and all limits must be prefixed with the namespace (see the example files).
     58
     59 * {{{<percentageLimit>}}} defines percentage limit and a rounding direction (up or down) relative to the size of a unit
     60 * {{{<sizeConstrainedLimit>}}} defines an upper limit that is also constrained by the unit size (i.e. if a unit has a unit size of 5 to 20 and can take ten of a weapon but no more than one weapon per trooper then the sizeConstrainedLimit will be the smaller of the unit size or the 10, the equipment limit)
     61 * {{{<absoluteLimit>}}} defines a fixed numeric limit that isn't constrained by the unit size (i.e. in the example above a unit of 5 troopers would still be able to take 10 of the item)
     62 * {{{<unitSizeLimit>}}} a shortcut for "all of the unit" (i.e. a 100% percentage limit)
    5463
    5564==== <unitEquipment> and <unitEquipmentItem> ====
    5665
    57 The {{{<unitEquipment>}}} tag is a container for {{{<unitEquipmentItem>}}} tags. unitEquipmentItem tags define the equipment that a unit can take by referencing an equipment item in the main list.
     66The {{{<unitEquipment>}}} tag is a container for {{{<unitEquipmentItem>}}} tags. unitEquipmentItem tags define the equipment that a unit can take by referencing an equipment item in the main list. Each unit equipment item can also contain minimum and maximum limit tags.
    5867
    5968 * {{{id}}} - the ID of the equipment item in the main list
    6069 * {{{required}}} - whether the item must be taken by the unit (e.g. swords for swordsmen)
    6170 * {{{exclusivityGroups}}} - a multi-valued string, split on comma (","). Defines a number of "groups" where only one item from the group can be taken at once
    62  * {{{minNum}}}/{{{maxNum}}} - the minimum and maximum number of times an item can be taken by each instance of the unit
    63  * {{{minPercentage}}}/{{{maxPercentage}}} - the minimum and maximum percentage of the unit who can be equiped with the item
    6471 * {{{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".
    6572 * {{{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.
    6673 * {{{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)
     74
     75===== <minLimit> and <maxLimit> =====
     76
     77Defines a minimum and maximum limit for equipment, which can be used in combination with equipment slot limits. See the equipment slot limits above for the allowed values of the limit tags. The default, if none is defined, is to use a unitSizeLimit (the default "equip all of the unit" behaviour of most game systems). If only a minimum limit or a maximum limit is defined then the other limit is set to the same value.
    6778
    6879==== <unitAbilities> and <unitAbility> ====