Civ4UnitClassInfos: Difference between revisions
Flying Pig (talk | contribs) (Created page with 'The '''CIV4UnitClassInfos''' file contains data about the different classes of unit. A class is the underlying connection between a Unique Unit and the parent unit; ech civilisat...') |
Ginger Ale (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
The ''' | The '''Civ4UnitClassInfos''' file contains data about the different classes of units. A class is the underlying connection between a unique unit and the parent unit (for example, a Praetorian and Swordsman), as each civilization can only have one unit type in each class. | ||
{| | All tags must be opened and closed; the first is the "open", the second the "close" tag. If nothing goes inside a "list tag", then it should just be the opening tag with a "/" before the closing bracket. The following tables contain all available tags, as well as their purpose and accepted values. | ||
==Tags== | |||
===Headers=== | |||
These tags typically bracket other tags, sometimes the entire file, and are generally used to specify more than one piece of data. | |||
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0" | |||
|- | |- | ||
! Tag ! | ! style="background:#efefef;" | Tag Name | ||
! style="background:#efefef;" | Description | |||
|- | |- | ||
! UnitClassInfos | ! UnitClassInfos | ||
Line 9: | Line 18: | ||
|- | |- | ||
! UnitClassInfo | ! UnitClassInfo | ||
| Each different unit's data is enclosed in a | | Each different unit's data is enclosed in a separate tag like this. | ||
|} | |||
===Text=== | |||
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0" | |||
|- | |||
! style="background:#efefef;" | Tag Name | |||
! style="background:#efefef;" | Description | |||
|- | |- | ||
! Type | ! Type | ||
| The name of the unit | | The name of the unit, which must be unique | ||
|- | |- | ||
! Description | ! Description | ||
| The name of the class as displayed on the screen | | The name of the class as displayed on the screen, used in the phrase explaining what normal unit the unique unit replaces | ||
|- | |||
! DefaultUnit | |||
| The unit which all civilizations have for this class, unless they have a unique unit to replace it | |||
|- | |||
|} | |||
===Integers=== | |||
All of these tags have a numerical value. Though it sometimes can be negative, it usually is not. | |||
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0" | |||
|- | |||
! style="background:#efefef;" | Tag Name | |||
! style="background:#efefef;" | Description | |||
|- | |- | ||
! iMaxGlobalInstances | ! iMaxGlobalInstances | ||
Line 24: | Line 57: | ||
|- | |- | ||
! iMaxPlayerInstances | ! iMaxPlayerInstances | ||
| The number of this unit that can exist at one time in each | | The number of this unit that can exist at one time in each civilization; -1 means no limit | ||
|- | |- | ||
! iInstanceCostModifier | ! iInstanceCostModifier | ||
| The increase to the cost of the unit for every one that exists; normally 0 | | The increase to the cost of the unit for every one that exists; normally 0 | ||
|} | |} | ||
==Example== | |||
In the following example of code, please note that there is a specific order of all of the tags. You ''must'' list the tags in this order for the game to properly interpret your file. | |||
<UnitClassInfos> | |||
<UnitClassInfo> | |||
<Type>UNITCLASS_LION</Type> | |||
<Description>TXT_KEY_UNIT_LION</Description> | |||
<iMaxGlobalInstances>-1</iMaxGlobalInstances> | |||
<iMaxTeamInstances>-1</iMaxTeamInstances> | |||
<iMaxPlayerInstances>-1</iMaxPlayerInstances> | |||
<iInstanceCostModifier>0</iInstanceCostModifier> | |||
<DefaultUnit>UNIT_LION</DefaultUnit> | |||
</UnitClassInfo> | |||
</UnitClassInfos> |
Revision as of 21:43, 23 May 2009
The Civ4UnitClassInfos file contains data about the different classes of units. A class is the underlying connection between a unique unit and the parent unit (for example, a Praetorian and Swordsman), as each civilization can only have one unit type in each class.
All tags must be opened and closed; the first is the "open", the second the "close" tag. If nothing goes inside a "list tag", then it should just be the opening tag with a "/" before the closing bracket. The following tables contain all available tags, as well as their purpose and accepted values.
Tags
Headers
These tags typically bracket other tags, sometimes the entire file, and are generally used to specify more than one piece of data.
Tag Name | Description |
---|---|
UnitClassInfos | This begins and ends the file. Everything must go in between these two, or it will not work. |
UnitClassInfo | Each different unit's data is enclosed in a separate tag like this. |
Text
Tag Name | Description |
---|---|
Type | The name of the unit, which must be unique |
Description | The name of the class as displayed on the screen, used in the phrase explaining what normal unit the unique unit replaces |
DefaultUnit | The unit which all civilizations have for this class, unless they have a unique unit to replace it |
Integers
All of these tags have a numerical value. Though it sometimes can be negative, it usually is not.
Tag Name | Description |
---|---|
iMaxGlobalInstances | The number of this unit that can exist at one time in the world; -1 means no limit |
iMaxTeamInstances | The number of this unit that can exist at one time in one team; -1 means no limit |
iMaxPlayerInstances | The number of this unit that can exist at one time in each civilization; -1 means no limit |
iInstanceCostModifier | The increase to the cost of the unit for every one that exists; normally 0 |
Example
In the following example of code, please note that there is a specific order of all of the tags. You must list the tags in this order for the game to properly interpret your file.
<UnitClassInfos> <UnitClassInfo> <Type>UNITCLASS_LION</Type> <Description>TXT_KEY_UNIT_LION</Description> <iMaxGlobalInstances>-1</iMaxGlobalInstances> <iMaxTeamInstances>-1</iMaxTeamInstances> <iMaxPlayerInstances>-1</iMaxPlayerInstances> <iInstanceCostModifier>0</iInstanceCostModifier> <DefaultUnit>UNIT_LION</DefaultUnit> </UnitClassInfo> </UnitClassInfos>