Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'src/client/action.h')
-rw-r--r--src/client/action.h80
1 files changed, 51 insertions, 29 deletions
diff --git a/src/client/action.h b/src/client/action.h
index 00ef210..0a7e247 100644
--- a/src/client/action.h
+++ b/src/client/action.h
@@ -20,48 +20,70 @@ namespace client
class Action
{
public:
- /// actions
- enum Identifier {None = 0,
- Console,
- Left, Right, Up, Down,
- RollLeft, RollRight,
- StrafeUp, StrafeDown,
- StrafeLeft, StrafeRight,
- ThrustUp, ThrustDown,
- Afterburner, Reverse,
- Control,
- CamLeft, CamRight, CamUp, CamDown,
- ZoomIn, ZoomOut,
- Fire
+ /**
+ * @brief type definition for the action type identifier
+ * */
+ enum Identifier
+ {
+ None = 0,
+ Console,
+ Left, Right, Up, Down,
+ RollLeft, RollRight,
+ StrafeUp, StrafeDown,
+ StrafeLeft, StrafeRight,
+ ThrustUp, ThrustDown,
+ Afterburner, Reverse,
+ Control,
+ CamLeft, CamRight, CamUp, CamDown,
+ ZoomIn, ZoomOut,
+ Fire,
+ FreeLook
};
- /// define a new action
- Action(const char *name, Identifier action, const char *info = 0);
+ /**
+ * @brief define a new action
+ * */
+ Action(const char *name, Identifier action, const char *description = 0);
+
+ /**
+ * @brief default destructor
+ * */
~Action();
- /// name
- inline std::string const & name() const {
- return action_name;
+ /**
+ * @brief action name
+ * */
+ inline std::string const & name() const
+ {
+ return _name;
}
- /// identifier
- inline Identifier id() const {
- return action_id;
+ /**
+ * @brief action type identifier
+ * */
+ inline Identifier id() const
+ {
+ return _id;
}
- /// text description
- inline std::string const & info() const {
- return action_info;
+ /**
+ * @brief text description
+ * */
+ inline std::string const & description() const
+ {
+ return _description;
}
- /// set info
- void set_info(const char *info);
+ /**
+ * @brief set the action's description
+ * */
+ void set_description(const char *description);
private:
- std::string action_name;
- std::string action_info;
- Identifier action_id;
+ std::string _name;
+ std::string _description;
+ Identifier _id;
};
} // namespace client