Civ4GameOptionInfos: Difference between revisions
(IryysmqEzV) |
m (Unprotected "Civ4GameOptionInfos") |
||
(7 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
The '''Civ4GameOptionInfos''' file defines what options are available in a particular game when starting from the custom game screen (such as Advanced Start, No Tech Trading, etc.). Changes to this file must be reflected in the SDK. | |||
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" | |||
|- | |||
! style="background:#efefef;" | Tag Name | |||
! style="background:#efefef;" | Description | |||
|- | |||
!GameOptionInfos | |||
|This tag surrounds the entries in the file | |||
|- | |||
!GameOptionInfo | |||
|Main bracket for each entry | |||
|} | |||
===Text=== | |||
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0" | |||
|- | |||
! style="background:#efefef;" | Tag Name | |||
! style="background:#efefef;" | Description | |||
|- | |||
!Type | |||
|How the option appears in other files | |||
|- | |||
!Description | |||
|The text for the option in the game | |||
|- | |||
!Help | |||
|Mouse-over text for the option in the game | |||
|} | |||
===Boolean=== | |||
All of these can either be 1 (on, or true) or 0 (off, or false). Be careful, as you can wind up with a double-negative, which the game will interpret as "True". | |||
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0" | |||
|- | |||
! style="background:#efefef;" | Tag Name | |||
! style="background:#efefef;" | Description | |||
|- | |||
!bDefault | |||
|Whether the option is on by default | |||
|- | |||
!bVisible | |||
|Whether the option is visible in the custom game screen | |||
|} | |||
==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. | |||
<GameOptionInfo> | |||
<Type>GAMEOPTION_ADVANCED_START</Type> | |||
<Description>TXT_KEY_GAME_OPTION_ADVANCED_START</Description> | |||
<Help>TXT_KEY_GAME_OPTION_ADVANCED_START_HELP</Help> | |||
<bDefault>0</bDefault> | |||
<bVisible>1</bVisible> | |||
</GameOptionInfo> | |||
{{Civ4_XML_Files}} |
Latest revision as of 01:40, 3 October 2011
The Civ4GameOptionInfos file defines what options are available in a particular game when starting from the custom game screen (such as Advanced Start, No Tech Trading, etc.). Changes to this file must be reflected in the SDK.
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 |
---|---|
GameOptionInfos | This tag surrounds the entries in the file |
GameOptionInfo | Main bracket for each entry |
Text
Tag Name | Description |
---|---|
Type | How the option appears in other files |
Description | The text for the option in the game |
Help | Mouse-over text for the option in the game |
Boolean
All of these can either be 1 (on, or true) or 0 (off, or false). Be careful, as you can wind up with a double-negative, which the game will interpret as "True".
Tag Name | Description |
---|---|
bDefault | Whether the option is on by default |
bVisible | Whether the option is visible in the custom game screen |
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.
<GameOptionInfo> <Type>GAMEOPTION_ADVANCED_START</Type> <Description>TXT_KEY_GAME_OPTION_ADVANCED_START</Description> <Help>TXT_KEY_GAME_OPTION_ADVANCED_START_HELP</Help> <bDefault>0</bDefault> <bVisible>1</bVisible> </GameOptionInfo>