These properties identify and classify an entity. Attributes include the unit's name, icon, class properties, tooltip rollover, historical information, and civilisation ownership.
<Traits> <Id> <Internal_Only /> <Generic>Infantry Spearman</Generic> <Specific>Caldeer</Specific> <Icon>sheet_civ</Icon> <Icon_Cell>42</Icon_Cell> <Classes>Unit, Infantry, Melee, Organic, CitizenSoldier, Male</Classes> <Civ>Celts</Civ> <Rollover>blah</Rollover> <History>blah</History> <Personal /> </Id> </Traits>
BRIEF DESCRIPTION :: Indicates that an XML file is an inheritable template or property container, and not an entity that will actually be usable in-game.
Use this attribute for all templates, and leave it out for the lowest items in the hierarchy.
BRIEF DESCRIPTION :: General name.
The general name of an entity is the name that takes the place of prominence in the user interface because the specific name is so foreign to the players.
This general name is also a name that will need to be translated to the native language (localised).
- Civilian Centre
- Wall Tower
- Scout Tower
- Infantry Swordsman
- Infantry Spearman
- Infantry Javelinist
- Infantry Slinger
- Infantry Archer
- Cavalry Swordsman
- Cavalry Spearman
- Cavalry Javelinist
- Cavalry Archer
- Female Citizen
- Super Unit
BRIEF DESCRIPTION :: Specific Name.
Every entity in the game will have a specific name. That name will be its historical/ancient name that is linked to its civilisation.
Since these will already use a regional language, they will not need to be localised.
Because ranked units are separate entities, this also includes names given to units of higher rank. For example, a veteran "Hastus" might have the Specific Latin name "Versatus Hastus".
BRIEF DESCRIPTION :: Points to Icon.
Subname of the icon used by the GUI for this entity's portrait.
BRIEF DESCRIPTION :: The element in a multi-icon portrait sheet where this entity's icon is stored.
If the entity has this attribute, it expects the Id.Icon to contain multiple icon frames in a single image. This value indicates which cell in the sheet to use for this entity's icon (cells are read 1..x, left->right, top->bottom).
BRIEF DESCRIPTION :: A list of strings identifying the unit. These can be used to categorise the entity in various ways.
Not yet implemented. Class strings can be generated, but at time of writing aren't used for anything.
Classes is a clever custom string that can be modified through inheritance. Each element is separated by a comma. When a value is specified, these elements are added to the Classes list, instead of overwriting the string with a replacement value. For example, if a parent has classes="class1, class2" and the child sets it to classes="class3, class4", these values are appended, resulting in a total Classes attribute for this entity of "class1, class2, class3, class4".
To remove a class from the list, use a minus ("-") prefix. For example, classes="class1, -class2" adds "class1" and removes "class2" if it is in the list.
The Classes string can be accessed in JS in an intelligent way. For example, if ( entity.hasClass( "some_class_id" )) will return success if the string exists in the list, without having to 'locate' through it to find that element.
Class strings will be implemented only as needed (for example, for technologies that affect certain groups of units), but some likely categories include:
- Aqua = Vegetation on water.
- Bow = Infantry Archer, Cavalry Archer.
- Cavalry = This is a variation of a Citizen Soldier (units with economic and military capabilities) that rides on a beast or is pulled by a beast. All Cavalry Citizen Soldiers: Cavalry Swordsman, Cavalry Spearman, Cavalry Javelinist, Cavalry Archer.
- Civic = Structures that 'serve the people'.
- CitizenSoldier = Land units that serves a dual economic and military role (split into Infantry Citizen Soldiers and Cavalry Citizen Soldiers): Infantry Swordsman, Infantry Spearman, Infantry Javelinist, Infantry Archer, Infantry Slinger, Cavalry Swordsman, Cavalry Spearman, Cavalry Javelinist, Cavalry Archer.
- Defensive Defensive Structures: Outpost, Wall, Tower, Gate, (any Wall or Tower SBs).
- Economic = Structures that promote an economy.
- Fauna = These are animals. Some are sources of Food.
- Flora = These are forms of vegetation. Vegetation on dry land.
- Foot' = Non-mounted infantry, support and special infantry: Infantry Citizen Soldiers, Female Citizen, Healer, Super Infantry Unit, non-mounted Heroes.
- Gaia = an entity that represents 'nature'.
- GaiaBuilding = A special building unique to Gaia (such as a Settlement).
- Geo = Non-living. Inorganic. These are rocks, minerals and anything in nature that isn't 'alive'.
- Hero = This is a legendary unit that is unique to a civilisation and has special powers. A significant figure from the civilisation's history: (all three Heroes for this civilisation).
- Housing Housing Structures: Civilian Centre, House, Farmstead, Dock, Market, Temple, Fortress.
- Infantry = This is a variation of a Citizen Soldier (units with economic and military capabilities) that walks on foot. All Infantry Citizen Soldiers: Infantry Swordsman, Infantry Spearman, Infantry Javelinist, Infantry Archer, Infantry Slinger.
- Javelin = Infantry Javelinist, Cavalry Javelinist.
- Mechanical = This unit is a mechanical weapon. A mechanical conveyance or weapon: Onager, Ballista, Ram, Merchantman, Bireme, Trireme, Quinquereme, Super Siege Unit (if applicable).
- Melee = Units that fight in hand-to-hand combat, typically associated with hack attack. (All units with a melee weapon.)
- Military = Structures that provide for the defense. Non-mechanical land units capable of attacking opposing units: Infantry Citizen Soldiers, Cavalry Citizen Soldiers, Super Units and Heroes.
- Mineral = Typically a source of Ore.
- Mounted = A "humanoid" unit that rides some kind of mount (horseback, camelback, donkey, animal drawn cart, elephant or chariot): Cavalry Citizen Soldiers, Super Cavalry Units, mounted Heroes.
- Norm = This is a normal structure. Some structures serve as training centres for units and gateways to researching of technologies.
- Offensive Military Production Structures: Civilian Centre, Barracks, Dock, Fortress.
- Organic = All units that aren't in the Mechanical category (basic and special infantry and cavalry, and support units).
- Other = anything that isn't a Unit, Structure, or Gaia (eg a projectile).
- PhaseCity = City Phase Structures: Fortress, (any SBs).
- PhaseTown = Town Phase Structures: Barracks, Market, Temple, Dock.
- PhaseVillage = Village Phase Structures: Civilian Centre, House, Mill, Farmstead, Field, Corral, Outpost, Wall, Tower, Gate.
- Plant = This is low lying vegetation. They're typically just eye candy.
- Projectile = An airborne weapon that causes damage.
- Ranged = Units that fight with missile weapons, typically associated with pierce attack. (All units with a ranged weapon.)
- Resource = Any entity from which a resource may be collected. Or this is not a structure at all, but a resource that can be 'built' by a player (fields and corrals).
- Rock = Typically a source of Stone.
- Ship = Provide passage over waterways. Merchantman, Bireme, Trireme, Quinquereme.
- Siege = Typically units whose purpose is the destruction of structures. Onager, Ballista, Land Ram.
- Sling = Infantry Slinger.
- Spear = Infantry Spearman, Cavalry Spearman.
- Special = Anything that doesn't fit the above categories.
- Stone (Civ-dependent; Structures constructed of stone).
- Structure = an entity that doesn't move around, but may be controlled by the player.
- SuperUnit = This unit is unique to a civilisation and has special traits that make it unique and super. A particularly powerful, rare and expensive unit, typically unique to a civilisation, and more likely than most units to require unique content. Its closest relation would probably be the Ao(x) UU: Super Infantry Unit, Super Cavalry/Siege? Unit.
- Supply Resource Structures: Civilian Centre, Mill, Farmstead.
- Support = These units do not have any military capabilities. Female Citizen, Healer, Trader.
- Sword = Infantry Swordsman, Cavalry Swordsman.
- Tower Tower Structures: Outpost, Tower, (any Tower SBs).
- Trade = Trader, Merchantman.
- Tree = This is tall vegetation. They're typically a source of Wood.
- Unit = an entity that can move around and may be controllable by a player.
- Wall = Wall Structures: Wall, (any Wall SBs).
- WarShip = A naval unit serving only a military purpose: Bireme, Trireme, Quinquereme.
- Wood = (Civ-dependent; Structures constructed of wood).
- Worker = Infantry Swordsman, Infantry Spearman, Infantry Javelinist, Infantry Archer, Infantry Slinger, Female Citizen.
BRIEF DESCRIPTION :: The name of the civilisation that owns this entity.
This is the full civilisation name, and might need to be localised, depending on the language.
An abbreviated four-character lower-case version of this property called civ_code is generated from JS when the entities are initialised, and used for internal reference to a civilisation.
A 'civilisation' in a game is defined as a collection of common entities. This civilisation is unique in its art, sounds, and gameplay when compared to other civilisations. The basis of this uniqueness is historical research.
Our ultimate goal is to feature the primary civilisations that existed between 500 B.C. and 500 A.D. (hence the title of 0 A.D.) The first release will focus on six civilisations spanning the first five hundred years of this millennial range:
- The Carthaginians - Carthaginians - kart
- The Celts - Celts - celt
- Britons - Britons - brit
- Gauls - Gauls - gaul
- The Hellenic City States - Hellenes - hele
- Athens - Athens - athe
- Sparta - Spartans - spar
- Macedonia - Macedonians - mace
- The Iberians - Iberians - iber
- The Persian Empire - Persians - pers
- Pre-Imperial Rome - Romans - rome
Britons, Gauls, Athens, Sparta, Macedonia are subsets of their respective parents.
BRIEF DESCRIPTION :: A paragraph of historical text about the unit.
Displayed in the game's on-line manual. Will need to be localised.
BRIEF DESCRIPTION :: Rollover text for GUI. Mouse selection.
This is a text string that is displayed in the GUI info box. This briefly covers the unit's purpose in the game, and then following that there will be information about what technologies can be used to improve the entity's statistics.
This will need to be translated to ensure that players can read this information.
BRIEF DESCRIPTION :: Indicates that each instance of this unit should be given a random "personal name".
Not yet implemented. Personal tag is in use, but scripting to generate names still needs to be done.
The generated name (if any) is stored in entity.traits.id.personal.name, and is determined from various ID attributes such as the civilisation, the class of unit (organic, mechanical) and gender (male, female, none) indicated in the ID.Classes attribute. This information is used to select an appropriate text list of random first and second names for the appropriate categories.
This could also be done with structures such as the Civilian Centre for random town name generation.