Copyright
Copyright 2005, Samuel Penn.
Redistribution and use in source, binary and printed forms with or without modification is permitted. See the full license text for details.
Copyright 2005, Samuel Penn.
Redistribution and use in source, binary and printed forms with or without modification is permitted. See the full license text for details.
The <vehicle> element is used to describe a vehicle, such as a tank, car or plane. It is of most use when game statistics are provided for the vehicle in question - currently only Dirtside is supported but other systems may be added later.
Currently there is basic support for calculating the points value of a vehicle given an XML description. This can also be extended to working out the points value of a whole army, by making use of the <import-army-list> tag.
Capacity calculation and validating the design are not yet supported, but they are planned features. However, they are not considered to be high priority.
<statistics xmlns="http://yagsbook.sourceforge.net/xml/dirtside">
<size> 4 </size>
<stealth> 1 </stealth>
<mobility type="grav">
</mobility>
<power type="fgp">
</power>
<elint>
<firecon quality="enhanced">
</firecon>
<ecm quality="basic">
</ecm>
</elint>
<armour front="4">
</armour>
<weapons>
<weapon type="MDC" class="4">
</weapon>
<weapon type="APSW" number="2">
</weapon>
</weapons>
<equipment>
<item name="pds" quality="enhanced">
</item>
</equipment>
</statistics>
The <statistics> element is the parent of all the Dirtside specific vehicle information. It will often have a single namespace attribute, which must be:
xmlns="http://yagsbook.sourceforge.net/xml/dirtside"
The following elements describe basic statistics for the vehicle, and are generally simple name, value pairs.
The size class of the vehicle. This will range from 1 to 5 for most vehicles. Note that there is no special support for oversize (6+) vehicles. This attribute is required.
e.g.: <size> 3 </size>
The number of levels of stealth on the vehicle. This will range from 0 up to the size class of the vehicle. It is required.
e.g.: <stealth> 1 </stealth>
The armour rating of the vehicle, together with any special properties of the armour. There may be future support for specific values for side and rear armour, but currently only front armour is supported, which is set with the @front attribute.
<armour front="3">
</armour>
The armour element may optionally include one special property, which will be either <reactive> or <ablative> . If both are included, the results are undefined.
Defines the mobility type of the vehicle. The format of this is as follows:
<mobility type="grav">
</mobility>
The allowed mobility types are: lowWheeled, highWheeled, slowTracked, fastTracked, slowGev, fastGev, grav, slowVtol, fastVtol.
Other mobility types are not currently supported.
Defines the power type of the vehicle.
<power type="cfe">
</power>
The allowed power plant types are: cfe, hmt, fgp.
The <elint> element contains information on fire controls and ECM systems. it is an optional element.
<elint>
<firecon quality="enhanced">
</firecon>
<ecm quality="basic">
</ecm>
</elint>
The <firecon> element has a single attribute named @quality. This is set to the quality of the firecon, and can be one of none, basic, enhanced, superior.
It is an optional element, and defaults to 'none'.
The <ecm> element has a single attribute named @quality. This is set to the quality of the ECM system, and can be one of none, basic, enhanced, superior.
It is an optional element, and defaults to 'none'.
The <weapons> element contains a list of all the direct fire weapons fitted on the vehicle. For example, a vehicle with a double MDC and a light GMS system would be described as follows:
<weapons>
<weapon type="MDC" class="4" number="2">
</weapon>
<weapon type="GMS/L" number="1" quality="basic">
</weapon>
</weapons>
Each individual type of weapon has its own <weapon> description. Multiple instances of the same type of weapon can be denoted using the @number attribute.
The weapon @type attribute should be one of the following values. The other attributes depend on the type of weapon, as described below.
The equipment element is parent to zero or more <item> elements, each of which describes one item of non-direct fire equipment that the vehicle carries.
Some types of equipment will have a quality associated with it - this quality will define the mass and cost of the item. In all cases, the @quality attribute should be one of basic, enhanced or superior.
Infantry is simply listed as to whether it is standard or powered infantry. The cost of infantry is not included in the vehicle cost, and it is expected that infantry units will be listed (and costed) seperately in army lists.
