Changeset 9260 for code/trunk/src/modules/gametypes/RaceCheckPoint.h

Timestamp:

Jun 2, 2012, 10:34:48 PM (12 years ago)

Author:

landauf

Message:

cleaned up new SpaceRace classes (no functional code-changes):

• formatting
• naming of variables, arguments, functions
• unused and duplicate code
• public member variables

File:

• code/trunk/src/modules/gametypes/RaceCheckPoint.h (modified) (3 diffs)

code/trunk/src/modules/gametypes/RaceCheckPoint.h

@@ -31 +31 @@
 
 #include "gametypes/GametypesPrereqs.h"
-
-
-
 #include "objects/triggers/DistanceMultiTrigger.h"
 #include "interfaces/RadarViewable.h"
@@ -42 +39 @@
     @brief
         The RaceCheckPoint class enables the creation of a check point to use in a SpaceRace level.
-         Don't forget to control the indexes of your check points and to set one last check point
+        Don't forget to control the indexes of your check points and to set one last check point
     */
     class _GametypesExport RaceCheckPoint : public DistanceMultiTrigger, public RadarViewable
@@ -51 +48 @@
 
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
-            virtual void tick(float dt);
+
             inline void setCheckpointIndex(int checkpointIndex)
-                { this->bCheckpointIndex_ = checkpointIndex; }
-            inline int getCheckpointIndex()
-                { return this->bCheckpointIndex_; }
+                { this->checkpointIndex_ = checkpointIndex; }
+            inline int getCheckpointIndex() const
+                { return this->checkpointIndex_; }
 
             inline void setNextcheckpoint(const Vector3& checkpoints)
-                { this->nextcheckpoints_=checkpoints; }
+                { this->nextcheckpoints_ = checkpoints; }
             inline void setNextcheckpoint(float x, float y, float z)
                 { this->setNextcheckpoint(Vector3(x, y, z)); }
             inline const Vector3& getNextcheckpoint() const
                 { return this->nextcheckpoints_; }
+
             inline void setLast(bool isLast)
                 { this->bIsLast_ = isLast; }
-            inline bool getLast()
+            inline bool isLast() const
                 { return this->bIsLast_; }
 
-            bool bIsLast_; //True if this check point is the last of the level. There can be only one last check point for each level and there must be a last check point in the level.
-            float bTimeLimit_; //The time limit (from the start of the level) to reach this check point. If the check point is reached after this time, the game ends and the player looses.
-            PlayerInfo* reached_;
-                
-            inline float getTimeLimit()
-                { return this->bTimeLimit_; }
-    
+            virtual void setTimelimit(float timeLimit);
+            inline float getTimeLimit() const
+                { return this->timeLimit_; }
+
+            inline PlayerInfo* getPlayer() const
+                { return this->player_; }
+            inline void resetPlayer()
+                { this->player_ = NULL; }
+
         protected:
-            virtual void fire(bool bIsTriggered,BaseObject* player);
-            virtual void setTimelimit(float timeLimit);
-            
+            virtual void fire(bool bIsTriggered, BaseObject* originator);
+
             inline const WorldEntity* getWorldEntity() const
                 { return this; }
 
         private:
-            int bCheckpointIndex_; //The index of this check point. The race starts with the check point with the index 0
-            Vector3 nextcheckpoints_; //the indexes of the next check points
-            
+            int checkpointIndex_;     ///< The index of this check point. The race starts with the check point with the index 0
+            Vector3 nextcheckpoints_; ///< the indexes of the next check points
+            bool bIsLast_;            ///< True if this check point is the last of the level. There can be only one last check point for each level and there must be a last check point in the level.
+            float timeLimit_;         ///< The time limit (from the start of the level) to reach this check point. If the check point is reached after this time, the game ends and the player looses.
+            PlayerInfo* player_;      ///< The player that reached the checkpoint
     };
 }