From b6141f6cbf07f0fbfadc892488f2ba83b7cf1719 Mon Sep 17 00:00:00 2001 From: Clyne Sullivan Date: Sat, 10 Dec 2016 18:33:40 -0500 Subject: doc updates --- include/brice.hpp | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) (limited to 'include/brice.hpp') diff --git a/include/brice.hpp b/include/brice.hpp index dc3ea96..1c4eccf 100644 --- a/include/brice.hpp +++ b/include/brice.hpp @@ -1,20 +1,59 @@ +/** + * @file brice.hpp + * @brief A system for saving player information. + */ + #ifndef BRICE_H_ #define BRICE_H_ #include namespace game { + + /** + * Allows the player to jump, if set to true. + */ extern bool canJump; + + /** + * Allows the player to sprint, if set to true. + */ extern bool canSprint; + /** + * Gets a value from the saved brice and returns it. + * @param id the id of the value + * @return the string value + */ std::string getValue(const std::string& id); + /** + * Sets a value in the brice, creating it if it doesn't exist. + * @param id the id of the value + * @param value the value + * @return true if the value was updated, not created + */ bool setValue(const std::string& id, const std::string& value); + /** + * Resets the brice to it's default values. + * Note: these are hardcoded into the program. + */ void briceClear(void); + + /** + * Saves the brice to it's file (brice.dat). + */ void briceSave(void); + + /** + * Loads the brice from it's file (brice.dat). + */ void briceLoad(void); + /** + * Reloads the brice. + */ void briceUpdate(void); } -- cgit v1.2.3