Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: abd70598130c60b53a96243625d360e69d08613b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
   client/action.h
   This file is part of the Osirion project and is distributed under
   the terms and conditions of the GNU General Public License version 2
*/

#ifndef __INCLUDED_CLIENT_ACTION_H__
#define __INCLUDED_CLIENT_ACTION_H__

#include <string>

namespace client
{

/** 
 * @brief a client action key slot. 
 * actions are interpreted directly by the client and do not go throught the
 * command line systems.
 */
class Action
{
public:
	/**
	 * @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,
		LookLeft, LookRight, LookUp, LookDown, 
		ZoomIn, ZoomOut,
		Fire,
		FreeLook
	};

	/**
	 * @brief define a new action
	 * */
	Action(const char *name, Identifier action, const char *description = 0);
	
	/**
	 * @brief default destructor
	 * */
	~Action();

	/**
	 * @brief action name
	 * */
	inline std::string const & name() const
	{
		return _name;
	}

	/**
	 * @brief action type identifier
	 * */
	inline Identifier id() const
	{
		return _id;
	}

	/**
	 * @brief text description
	 * */
	inline std::string const & description() const
	{
		return _description;
	}

	/**
	 * @brief set the action's description
	 * */
	void set_description(const char *description);


private:
	std::string		_name;
	std::string		_description;
	Identifier		_id;
};

} // namespace client

#endif // __INCLUDED_CLIENT_ACTION_H__