Changes between Version 9 and Version 10 of code/doc/SpaceBoundaries

Timestamp:

May 12, 2011, 2:23:37 PM (14 years ago)

Author:

kmaurus

Comment:

—

code/doc/SpaceBoundaries

@@ -5 +5 @@
 
 == Implementation ==
-A new class that is derived from static entity will be written that 
-checks for any other entities that are in danger of getting out of range
-of the center of the map. It will be called SpaceBoundaries.
+SpaceBoundaries is a class that is derived from static entity. It checks if
+there is a pawn that is outside of a defined area or tries to leave this area
+and reacts on such events.
 
-A map creator can then add the boundaries to a level via its XML file and 
-specify the attributes necessary for it to work.
+The reaction to such events can be defined by the map creator, who can add
+boundaries to a level via its XML file. At the moment there are two implemented behaviors:
+ * Let the Pawns that want to cross the boundaries bounce back.
+ * Let the Pawns cross the boundaries but decrease their health when they do so.
 
-The SpaceBoundaries object will do its work in the tick function, using an 
-Iterator of type MobileEntity. Via the interface of MobileEntity, we can then 
+The SpaceBoundaries object does its work in the tick function, using an 
+Iterator of type Pawn. Via the interface of Pawn, we can then 
 control the pawns away from the boundary or do damage to them.
-
-Goals of the implementation:
- * Detection of pawns exiting the allowed range
- * Reaction to those pawns
- * Preliminary distance measurement: 2-norm
- * (Later: maybe max-norm or 1-norm)
- * Graphical representation of boundaries
 
 == Attributes ==
 These attributes can be set for a SpaceBoundaries static entity in the XML file:
- * position - absolute position of the space boundaries in the level (usually 0,0,0)
- * maxdistance - maximum distance pawns can move away from this point
- * warndistance - distance at which pawns receive some kind of warning that they're about to reach
+ * position - absolute position of the object of SpaceBoundaries in the level (usually 0,0,0)
+ * maxDistance - defines the area, where a pawn is allowed to be (radius of a ball with center 'position').
+ * warnDistance - If the distance between the pawn of a human player and 'position' is bigger than 'warnDistance', a message is displayed to inform the player that he's close to the boundary.
+ * showDistance - If the distance between the pawn and the boundary of the allowed area is smaller than 'showDistance', a graphical representation of the boundary is displayed.
+ * reactionMode - Integer-Value. Defines what effect appears if a space ship has crossed receptively wants to cross the boundaries.
+  * 0: Reflect the space ship (default).
+  * 1: Decrease Health of the space ship after having left the allowed area.
+ * healthDecrease - a measure to define how fast the health of a pawn should decrease after leaving the allowed area (unnecessary if 'reactionMode' == 0). Recommended values: 0.1 (slow health decrease) to 5 (very fast health decrease).
 
-== Actions taken when a pawn reaches the boundary ==
-Several measures can be taken when something reaches the boundaries of the level:
- * Damage - the entity could take constant damage over time as long as it is outside the borders
- * Acceleration changes - some kind of invisible wall or acceleration away from the boundary
- * Visual impairment - darkness, fuzziness or something along those lines
+=== Notes to above attributes ===
+Until now, warnDistance has no effect because the function to display a message (void SpaceBoundaries::displayWarning(const std::string warnText)) hasn't been implemented yet.
+