SmartFoxServer 2X C++ API
RoomProperties.h
1 // ===================================================================
2 //
3 // Description
4 // Contains the definition of RoomProperties
5 //
6 // Revision history
7 // Date Description
8 // 30-Nov-2012 First version
9 //
10 // ===================================================================
11 #ifndef __RoomProperties__
12 #define __RoomProperties__
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 RoomProperties
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> GROUP_ID;
53 
57  static boost::shared_ptr<string> MAX_USERS;
58 
62  static boost::shared_ptr<string> MAX_SPECTATORS;
63 
67  static boost::shared_ptr<string> USER_COUNT;
68 
72  static boost::shared_ptr<string> SPECTATOR_COUNT;
73 
77  static boost::shared_ptr<string> IS_GAME;
78 
82  static boost::shared_ptr<string> IS_PRIVATE;
83 
87  static boost::shared_ptr<string> HAS_FREE_PLAYER_SLOTS;
88 
92  static boost::shared_ptr<string> IS_TYPE_SFSGAME;
93 
94  protected:
95 
96  // -------------------------------------------------------------------
97  // Protected methods
98  // -------------------------------------------------------------------
99 
100  // -------------------------------------------------------------------
101  // Protected members
102  // -------------------------------------------------------------------
103 
104  private:
105 
106  // -------------------------------------------------------------------
107  // Private methods
108  // -------------------------------------------------------------------
109 
110  // -------------------------------------------------------------------
111  // Private members
112  // -------------------------------------------------------------------
113  };
114 
115 } // namespace Match
116 } // namespace Entities
117 } // namespace Sfs2X
118 
119 #endif
static boost::shared_ptr< string > IS_PRIVATE
The Room isPrivate flag
Definition: RoomProperties.h:82
static boost::shared_ptr< string > NAME
The Room name
Definition: RoomProperties.h:47
STL namespace.
static boost::shared_ptr< string > USER_COUNT
The Room user count
Definition: RoomProperties.h:67
static boost::shared_ptr< string > MAX_USERS
The Room max users
Definition: RoomProperties.h:57
static boost::shared_ptr< string > SPECTATOR_COUNT
The Room spectator count
Definition: RoomProperties.h:72
static boost::shared_ptr< string > IS_GAME
The Room isGame flag
Definition: RoomProperties.h:77
static boost::shared_ptr< string > HAS_FREE_PLAYER_SLOTS
Check if the Room has at least 1 free player slot
Definition: RoomProperties.h:87
static boost::shared_ptr< string > MAX_SPECTATORS
The Room max spectators
Definition: RoomProperties.h:62
A list of additional properties that can be used in MatchExpressions for Room objects ...
Definition: RoomProperties.h:32
Definition: SmartFox.cpp:24
static boost::shared_ptr< string > GROUP_ID
The Room group id
Definition: RoomProperties.h:52
static boost::shared_ptr< string > IS_TYPE_SFSGAME
Check if the Room is of type SFSGame
Definition: RoomProperties.h:92