libHSPlasma
Classes | Public Member Functions | Protected Member Functions | List of all members
plNetMsgRoomsList Class Reference

#include <plNetMsgRoomsList.h>

Inheritance diagram for plNetMsgRoomsList:
plNetMessage plCreatable plNetMsgGameStateRequest plNetMsgPagingRoom

Classes

struct  Room

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< Room > & getRooms () const
std::vector< Room > & getRooms ()
void addRoom (const plLocation &loc, const plString &name)
void delRoom (size_t idx)
void clearRooms ()
- Public Member Functions inherited from plNetMessage
 plNetMessage ()
unsigned int getFlags () const
unsigned char getProtocolVerMaj () const
unsigned char getProtocolVerMin () const
plUnifiedTime getTimeSent () const
unsigned int getContext () const
unsigned int getTransID () const
unsigned int getPlayerID () const
plUuid getAcctUuid () const
void setFlags (unsigned int flags)
void setTimeSent (const plUnifiedTime &timeSent)
void setContext (unsigned int context)
void setTransID (unsigned int transID)
void setPlayerID (unsigned int playerID)
void setAcctUuid (const plUuid &acctUuid)
void setProtocolVer (unsigned char maj, unsigned char min)
- Public Member Functions inherited from plCreatable
 plCreatable ()
virtual ~plCreatable ()
virtual short ClassIndex () const =0
short ClassIndex (PlasmaVer ver) const
virtual const char * ClassName () const
virtual bool ClassInstance (short) const
virtual bool isStub () const
virtual void prcWrite (pfPrcHelper *prc)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Additional Inherited Members

- Public Types inherited from plNetMessage
enum  ContentFlags {
  kHasTimeSent = 0x1, kHasGameMsgRecvrs = 0x2, kEchoBackToSender = 0x4, kRequestP2P = 0x8,
  kAllowTimeOut = 0x10, kIndirectMember = 0x20, kPublicIPClient = 0x40, kHasContext = 0x80,
  kAskVaultForGameState = 0x100, kHasTransactionID = 0x200, kNewSDLState = 0x400, kInitialAgeStateRequest = 0x800,
  kHasPlayerID = 0x1000, kUseRelevanceRegions = 0x2000, kHasAcctUuid = 0x4000, kInterAgeRouting = 0x8000,
  kHasVersion = 0x10000, kIsSystemMessage = 0x20000, kNeedsReliableSend = 0x40000, kRouteToAllPlayers = 0x80000
}

Member Function Documentation

void plNetMsgRoomsList::addRoom ( const plLocation loc,
const plString name 
)
void plNetMsgRoomsList::clearRooms ( )
void plNetMsgRoomsList::delRoom ( size_t  idx)
const std::vector<Room>& plNetMsgRoomsList::getRooms ( ) const
std::vector<Room>& plNetMsgRoomsList::getRooms ( )
virtual void plNetMsgRoomsList::IPrcParse ( const pfPrcTag tag,
plResManager mgr 
)
protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plNetMessage.

Reimplemented in plNetMsgPagingRoom.

virtual void plNetMsgRoomsList::IPrcWrite ( pfPrcHelper prc)
protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from plNetMessage.

Reimplemented in plNetMsgPagingRoom.

virtual void plNetMsgRoomsList::read ( hsStream ,
plResManager  
)
virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plNetMessage.

Reimplemented in plNetMsgPagingRoom.

virtual void plNetMsgRoomsList::write ( hsStream ,
plResManager  
)
virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plNetMessage.

Reimplemented in plNetMsgPagingRoom.


The documentation for this class was generated from the following file: