1 #ifndef ERIS_CHARACTERTYPE_H_
2 #define ERIS_CHARACTERTYPE_H_
3 
4 #include <string>
5 
6 namespace Eris
7 {
8 
9 /**
10  * @brief An available character type which a client can create a character from on the server.
11  * This is presented to the client when first connected to the server and allows a user to select what kind of character to create in the world.
12  *
13  * @author Erik Hjortsberg <erik.hjortsberg@gmail.com>
14  */
15 class CharacterType
16 {
17 public:
18     /**
19      * @brief Ctor.
20      * @param name The name of the character type.
21      * @param description A description to show the user.
22      */
23     CharacterType(const std::string& name, const std::string& description);
24 
25     /**
26      * @brief Accessor for the name of the character type.
27      * @returns The name of the character type.
28      */
29     const std::string& getName() const;
30 
31     /**
32      * @brief Accessor for the description of the character type.
33      * @returns A description of the character type.
34      */
35     const std::string& getDescription() const;
36 
37 private:
38 
39     /**
40      * @brief The name of the character type.
41      */
42     std::string m_name;
43 
44     /**
45      * @brief A description of the character type.
46      */
47     std::string m_description;
48 };
49 
50 }
51 
52 #endif /* ERIS_CHARACTERTYPE_H_ */
53