Changeset 8237 for code/branches/spaceboundaries/src/orxonox/worldentities

Timestamp:

Apr 12, 2011, 7:54:36 PM (14 years ago)

Author:

kmaurus

Message:

some comments added

File:

• code/branches/spaceboundaries/src/orxonox/worldentities/SpaceBoundaries.h (modified) (3 diffs)

code/branches/spaceboundaries/src/orxonox/worldentities/SpaceBoundaries.h

@@ -50 +50 @@
 
        Four attributes can/should be defined in the XML-File:
-       'position', 'warnDistance', 'maxDistance', 'healthDecrease'.
+       - 'position' : absolute position of the SpaceBoundaries class. '*Distance' refers to this 'position'.
+       - 'warnDistance' : If the distance between the pawn of the human player and 'position' is bigger than 'warnDistance', a message is displayed to
+                          inform the player that he'll soon be leaving the allowed area. 
+       - 'maxDistance' : defines the area, where a pawn is allowed to be (radius of a ball).
+       - 'healthDecrease' : a measure to define how fast the health of a pawn should decrease after leaving the allowed area.
+                            Empfohlene Werte: 0.1 (langsame Health-Verminderung) bis 5 (sehr schnelle Health-Verminderung)
 */
 
@@ -61 +66 @@
             ~SpaceBoundaries();
             
-            void setMaxDistance(float r);
+            void se     tMaxDistance(float r);
             float getMaxDistance();
             
@@ -81 +86 @@
                                    //!< Empfohlene Werte: 0.1 (langsame Health-Verminderung) bis 5 (sehr schnelle Health-Verminderung)
             
-            RadarViewable* centerRadar_; //!< Repraesentation von 'this->getPosition()' auf dem Radar.
+            RadarViewable* centerRadar_; //!< Repraesentation von SpaceBoundaries auf dem Radar.
         
             float computeDistance(WorldEntity *item); //!< Auf den Mittelpunkt 'this->getPosition()' bezogen.