diff options
| author | mario <mario@notk.org> | 2011-11-30 03:46:41 +0100 |
|---|---|---|
| committer | mario <mario@notk.org> | 2011-11-30 03:46:41 +0100 |
| commit | 871745156d679f82f3be060af83dfd51a3416f09 (patch) | |
| tree | c17729ebf4c28991e02029e46ecb6d122b77c152 /Game.h | |
| parent | f5c32b3b880deb0ff2eee7243e3f112469841e95 (diff) | |
~Doxygen-style commented. Not exactly doxygen but compatible and close enough.
Diffstat (limited to 'Game.h')
| -rw-r--r-- | Game.h | 36 |
1 files changed, 34 insertions, 2 deletions
@@ -16,17 +16,49 @@ public: virtual ~Game(void);
public:
-
+ /**
+ * Pauses the game
+ **/
void pauseGame();
+ /**
+ * Resumes the game
+ **/
void resumeGame();
+ /**
+ * Toggle between pause & resume
+ **/
void toggleGame();
+ /**
+ * Returns true if the game is not paused
+ **/
bool isRunning();
+ /**
+ * Restarts the game. It will not be paused. All dead player will live again, at original positions and original directions.
+ **/
void restart();
+ /**
+ * Starts the game the first time. The game will be paused.
+ **/
void start();
+ /**
+ * Go for 1 round if enough time passed
+ **/
void updateGame(uint timeElapsedMs);
+ /**
+ * Returns a specific player giver its ID
+ **/
Player* getPlayerByID(PlayerNumber id);
+ /**
+ * Returns the field
+ **/
Field& getField();
- void init(int width, int height, PlayerNumber num);
+ /**
+ * Changed the size of the game and the field
+ **/
+ void setSize(int width, int height);
+ /**
+ * Adds a new player with default parameters.
+ **/
Player* addPlayer();
private:
|