SmartFoxServer 2X C++ API
UserProperties.h
1 // ===================================================================
2 //
3 // Description
4 // Contains the definition of UserProperties
5 //
6 // Revision history
7 // Date Description
8 // 30-Nov-2012 First version
9 //
10 // ===================================================================
11 #ifndef __UserProperties__
12 #define __UserProperties__
13 
14 #include "../../Util/Common.h"
15 
16 #include <boost/shared_ptr.hpp> // Boost Asio shared pointer
17 
18 #if defined(_MSC_VER)
19 #pragma warning(disable:4786) // STL library: disable warning 4786; this warning is generated due to a Microsoft bug
20 #endif
21 #include <string> // STL library: string object
22 using namespace std; // STL library: declare the STL namespace
23 
24 namespace Sfs2X {
25 namespace Entities {
26 namespace Match {
27 
32  class DLLImportExport UserProperties
33  {
34  public:
35 
36  // -------------------------------------------------------------------
37  // Public methods
38  // -------------------------------------------------------------------
40 
41  // -------------------------------------------------------------------
42  // Public members
43  // -------------------------------------------------------------------
47  static boost::shared_ptr<string> NAME;
48 
52  static boost::shared_ptr<string> IS_PLAYER;
53 
57  static boost::shared_ptr<string> IS_SPECTATOR;
58 
62  static boost::shared_ptr<string> IS_NPC;
63 
67  static boost::shared_ptr<string> PRIVILEGE_ID;
68 
72  static boost::shared_ptr<string> IS_IN_ANY_ROOM;
73 
74  protected:
75 
76  // -------------------------------------------------------------------
77  // Protected methods
78  // -------------------------------------------------------------------
79 
80  // -------------------------------------------------------------------
81  // Protected members
82  // -------------------------------------------------------------------
83 
84  private:
85 
86  // -------------------------------------------------------------------
87  // Private methods
88  // -------------------------------------------------------------------
89 
90  // -------------------------------------------------------------------
91  // Private members
92  // -------------------------------------------------------------------
93  };
94 
95 } // namespace Match
96 } // namespace Entities
97 } // namespace Sfs2X
98 
99 #endif
static boost::shared_ptr< string > PRIVILEGE_ID
The User privilege Id
Definition: UserProperties.h:67
static boost::shared_ptr< string > IS_IN_ANY_ROOM
Checks if User.lastJoinedRoom == null, in other words the User is not joined in any Room ...
Definition: UserProperties.h:72
STL namespace.
static boost::shared_ptr< string > NAME
The user name
Definition: UserProperties.h:47
static boost::shared_ptr< string > IS_SPECTATOR
The isSpectator flag
Definition: UserProperties.h:57
A list of additional properties that can be used in MatchExpressions for User objects ...
Definition: UserProperties.h:32
Definition: SmartFox.cpp:24
static boost::shared_ptr< string > IS_PLAYER
The isPlayer flag
Definition: UserProperties.h:52
static boost::shared_ptr< string > IS_NPC
The isNPC flag
Definition: UserProperties.h:62