libHSPlasma
Public Types | Public Member Functions | Protected Member Functions | List of all members
plNetMsgPagingRoom Class Reference

#include <plNetMsgRoomsList.h>

Inheritance diagram for plNetMsgPagingRoom:
plNetMsgRoomsList plNetMessage plCreatable

Public Types

enum  PageFlags { kPagingOut = 0x1, kResetList = 0x2, kRequestState = 0x4, kFinalRoomInAge = 0x8 }

Public Member Functions

 plNetMsgPagingRoom ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
unsigned char getPageFlags () const
void setPageFlags (unsigned char flags)
- Public Member Functions inherited from plNetMsgRoomsList
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)

Member Enumeration Documentation

Enumerator:
kPagingOut 
kResetList 
kRequestState 
kFinalRoomInAge 

Constructor & Destructor Documentation

plNetMsgPagingRoom::plNetMsgPagingRoom ( )

Member Function Documentation

unsigned char plNetMsgPagingRoom::getPageFlags ( ) const
virtual void plNetMsgPagingRoom::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 plNetMsgRoomsList.

virtual void plNetMsgPagingRoom::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 plNetMsgRoomsList.

virtual void plNetMsgPagingRoom::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 plNetMsgRoomsList.

void plNetMsgPagingRoom::setPageFlags ( unsigned char  flags)
virtual void plNetMsgPagingRoom::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 plNetMsgRoomsList.


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