Difference between revisions of "Config Item Purposes"

From Armagetron
m (Wrapped console commands in code tags)
(5 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
== nSettingItem ==
 
== nSettingItem ==
  
Transferred over the network.  These are settings that are controlled by the server, such as CYCLE_RUBBER.
+
Transferred over the network from the server.
 +
 
 +
=== Examples of Usage ===
 +
* <code>cycle_rubber</code>
 +
* <code>cycle_delay</code>
  
 
== tSettingItem ==
 
== tSettingItem ==
  
 
Local settings that are loaded from settings.cfg.  You may change these setting in-game, but they are not saved when you quit. To make the changes permanent you must edit your configuration files.
 
Local settings that are loaded from settings.cfg.  You may change these setting in-game, but they are not saved when you quit. To make the changes permanent you must edit your configuration files.
 +
 +
=== Examples of Usage ===
 +
* <code>camera_custom_back</code>
 +
* <code>camera_custom_pitch</code>
  
 
== tConfItem ==
 
== tConfItem ==
 +
Local settings that are saved on quit. These setting typically have an interface to be changed, such as a menu item.
  
Local settings.  These are saved when quitting and include things like video card options, resolution settings, player names, instant chats, and the like.
+
=== Examples of Usage ===
 +
* Player names
 +
* Key mappings
 +
* Instant chat macros
 +
* Resolution settings
  
 
== Variants ==
 
== Variants ==
  
 
The XItemLine variant is a specialization of the XItem< tString > class with the difference that it saves and reads whole lines of config files, while the standard item will only read the first word.
 
The XItemLine variant is a specialization of the XItem< tString > class with the difference that it saves and reads whole lines of config files, while the standard item will only read the first word.

Revision as of 15:57, 21 October 2005

Choose the right kind of setting item:

nSettingItem

Transferred over the network from the server.

Examples of Usage

  • cycle_rubber
  • cycle_delay

tSettingItem

Local settings that are loaded from settings.cfg. You may change these setting in-game, but they are not saved when you quit. To make the changes permanent you must edit your configuration files.

Examples of Usage

  • camera_custom_back
  • camera_custom_pitch

tConfItem

Local settings that are saved on quit. These setting typically have an interface to be changed, such as a menu item.

Examples of Usage

  • Player names
  • Key mappings
  • Instant chat macros
  • Resolution settings

Variants

The XItemLine variant is a specialization of the XItem< tString > class with the difference that it saves and reads whole lines of config files, while the standard item will only read the first word.