MutableRoom Class Reference

Inheritance diagram for MutableRoom:

Collaboration diagram for MutableRoom:

Public Member Functions
	MutableRoom (const MutableRoom &toCopy)
virtual MutableRoom &	operator= (const Room &toCopy)
virtual MutableRoom &	operator= (const MutableRoom &toCopy)
nByte	getPlayerCount (void) const
bool	setMaxPlayers (nByte maxPlayers, const WebFlags &webflags=WebFlags())
bool	setIsOpen (bool isOpen, const WebFlags &webflags=WebFlags())
bool	getIsVisible (void) const
bool	setIsVisible (bool isVisible, const WebFlags &webflags=WebFlags())
const Common::JVector< Player * > &	getPlayers (void) const
const Player *	getPlayerForNumber (int playerNumber) const
int	getMasterClientID (void) const
const Common::JVector< Common::JString > &	getPropsListedInLobby (void) const
bool	setPropsListedInLobby (const Common::JVector< Common::JString > &propsListedInLobby, const Common::JVector< Common::JString > &expectedList=Common::JVector< Common::JString >(), const WebFlags &webflags=WebFlags())
int	getPlayerTtl (void) const
int	getEmptyRoomTtl (void) const
bool	getSuppressRoomEvents (void) const
const Common::JVector< Common::JString > *	getPlugins (void) const
bool	getPublishUserID (void) const
const Common::JVector< Common::JString > &	getExpectedUsers (void) const
bool	setExpectedUsers (const Common::JVector< Common::JString > &expectedUsers, const WebFlags &webflags=WebFlags())
bool	setMasterClient (const Player &masterClientPlayer)
bool	mergeCustomProperties (const Common::Hashtable &customProperties, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
template<typename ktype , typename vtype >
bool	addCustomProperty (const ktype &key, const vtype &value, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
template<typename ktype , typename vtype >
bool	addCustomProperty (const ktype &key, const vtype pValueArray, int arrSize, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
template<typename ktype , typename vtype >
bool	addCustomProperty (const ktype &key, const vtype pValueArray, const int *pArrSizes, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
bool	addCustomProperties (const Common::Hashtable &customProperties, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
template<typename ktype >
bool	removeCustomProperty (const ktype &key, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
template<typename ktype >
bool	removeCustomProperties (const ktype *keys, unsigned int count, const Common::Hashtable &expectedCustomProperties=Common::Hashtable(), const WebFlags &webflags=WebFlags())
virtual Common::JString	toString (bool withTypes=false, bool withCustomProperties=false, bool withPlayers=false) const
virtual Common::JString &	toString (Common::JString &retStr, bool withTypes=false) const
virtual Common::JString	toString (bool withTypes, bool withCustomProperties) const
Public Member Functions inherited from Room
virtual	~Room (void)
	Room (const Room &toCopy)
const Common::JString &	getName (void) const
nByte	getMaxPlayers (void) const
bool	getIsOpen (void) const
nByte	getDirectMode (void) const
const Common::Hashtable &	getCustomProperties (void) const
bool	operator== (const Room &room) const
virtual Common::JString &	toString (Common::JString &retStr, bool withTypes=false) const
virtual Common::JString	toString (bool withTypes, bool withCustomProperties) const
virtual JString &	toString (JString &retStr, bool withTypes=false) const=0
JString	toString (bool withTypes=false) const
Public Member Functions inherited from ToString
virtual	~ToString (void)
virtual JString	typeToString (void) const
JString	toString (bool withTypes=false) const

Member Function Documentation

operator=()

MutableRoom & operator= ( const Room &  toCopy )

virtual

operator=.

Makes a deep copy of its right operand into its left operand.

This overwrites old data in the left operand.

Reimplemented from Room.

getPlayerCount()

nByte getPlayerCount ( void  ) const

virtual

Returns

the count of players that are currently inside this room

Reimplemented from Room.

toString()

JString toString

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

withTypes	set to true, to include type information in the generated string
withCustomProperties	set to true, to include the custom properties in the generated string