Changeset 706

Timestamp:

Dec 28, 2007, 3:00:01 AM (17 years ago)

Author:

landauf

Message:

added descriptions to the existing config-values

Location:

code/branches/FICN/src/orxonox

Files:

• core/DebugLevel.cc (modified) (1 diff)
• objects/Fighter.cc (modified) (1 diff)
• objects/Projectile.cc (modified) (1 diff)
• objects/SpaceShip.cc (modified) (1 diff)

code/branches/FICN/src/orxonox/core/DebugLevel.cc

@@ -52 +52 @@
     void DebugLevel::setConfigValues()
     {
-        SetConfigValue(softDebugLevelConsole_, 3);
-        SetConfigValue(softDebugLevelLogfile_, 3);
-        SetConfigValue(softDebugLevelShell_, 1);
+        SetConfigValue(softDebugLevelConsole_, 3).description("The maximal level of debug output shown in the console");
+        SetConfigValue(softDebugLevelLogfile_, 3).description("The maximal level of debug output shown in the logfile");
+        SetConfigValue(softDebugLevelShell_, 1).description("The maximal level of debug output shown in the ingame shell");
 
         // softDebugLevel_ is the maximum of the 3 variables

code/branches/FICN/src/orxonox/objects/Fighter.cc

@@ -106 +106 @@
     void Fighter::setConfigValues()
     {
-        SetConfigValue(bInvertMouse_, false);
+        SetConfigValue(bInvertMouse_, false).description("Set this to true for joystick-like mouse behaviour (mouse up = ship down).");
     }
 

code/branches/FICN/src/orxonox/objects/Projectile.cc

@@ -65 +65 @@
     void Projectile::setConfigValues()
     {
-        SetConfigValue(lifetime_, 10.0);
-        SetConfigValue(speed_, 2000.0);
+        SetConfigValue(lifetime_, 10.0).description("The time in seconds a projectile stays alive");
+        SetConfigValue(speed_, 2000.0).description("The speed of a projectile in units per second");
     }
 

code/branches/FICN/src/orxonox/objects/SpaceShip.cc

@@ -124 +124 @@
     void SpaceShip::setConfigValues()
     {
-        SetConfigValue(bInvertYAxis_, false);
-        SetConfigValue(reloadTime_, 0.125);
+        SetConfigValue(bInvertYAxis_, false).description("Set this to true for joystick-like mouse behaviour (mouse up = ship down).");
+        SetConfigValue(reloadTime_, 0.125).description("The reload time of the weapon in seconds");
     }