Knowledgebase Article 47


Defining Unit Sets

You can group several vehicles together to form a unitset. In the mapeditor, you can enable and disable unitsets to make the selection of units easier. You can also define transformations that replace all units on a map by others. This is useful if you want to play a map with a different unit set than the one that is originally used by the map.

To define a unit set, you must create a unitset definition file, which is a plain text file with the extension .set . I suggest that you put all vehicles together with this unitset definition file into a single data container.

Here is an example for a unitset definition file:

#V2#
NAME=Standard Unitset
ID=0-800,900,920-930,950
BUILDINGID=0-400,507
MAINTAINER=Martin Bickel (martin@asc-hq.org)
INFORMATION=This unitset is part of the standard ASC data package which can be obtained from http://www.asc-hq.org
IDENTIFICATION=2
TRANSFORMATION=Example transformation;24,1840;25,1872;26,1805;27,1839;28,1878;29,1845;30,1834;31,1859;32,1821;33,1862;34,1810
TRANSFORMATION=Another transformation;77,1877;78,1878;79,1879;1000,1822;1001,1829;1002,1806

The first line must always be #V2#. This is to tell ASC that this is the second revision of the unitset definition file format. It is still possible to use the files with the old format, but if you create a new one use this new format.

Each of the following lines starts with a keyword, which must be UPPERCASE, an equals sign and some data. The order in which the properties are defined is not relevant.

NAME
The name of the unitset. It should not be longer than maybe 15 Characters.This field is required.

ID
The IDs of the units that form the unitset. This field is required.

BUILDINGID
The IDs of the building that belong o the unitset. This field is optional.

MAINTAINER
Some information about the person who maintains the unitset. This field is optional.

INFORMATION
Some information about the unitset. The internet address where new versions can be optained is useful here. This field is optional.

IDENTIFICATION
This is a numerical ID that is used by the WeaponGuide program to identify a unit set. The ID should be unique and therefore it should be part of the ID space of the unit set. This field is optional.

TRANSFORMATION
The field consists of the transformations name, a semicolon ( ; ) and a list of pairs of IDs. The first number is the ID of the unittype that will be replaced by the unittype with the second ID when this transformation is executed. In the above example, all units with ID 24 are replaced by units with ID 1840, all units with ID 25 are replaced by units with ID 1872, etc. You may define any number of transformations. Each transformation must be in a single line. These fields are optional.

Last change: Mon, 2004-08-02 14:46


search knowledgebase
browse knowledgebase