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

#include <plClientGuid.h>

Inheritance diagram for plClientGuid:
plCreatable

Public Types

enum  Flags {
  kAcctUuid = 0x1, kPlayerID = 0x2, kTempPlayerID = 0x4, kCCRLevel = 0x8,
  kProtectedLogin = 0x10, kBuildType = 0x20, kPlayerName = 0x40, kSrcAddr = 0x80,
  kSrcPort = 0x100, kReserved = 0x200, kClientKey = 0x400
}

Public Member Functions

 plClientGuid ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
unsigned short getFlags () const
plUuid getAcctUuid () const
unsigned int getPlayerID () const
plString getPlayerName () const
unsigned char getCCRLevel () const
unsigned char getProtectedLogin () const
unsigned char getBuildType () const
unsigned int getSrcAddr () const
unsigned short getSrcPort () const
unsigned short getReserved () const
plString getClientKey () const
void setFlags (unsigned short flags)
void setAcctUuid (const plUuid &acctUuid)
void setPlayerID (unsigned int playerID)
void setPlayerName (const plString &playerName)
void setCCRLevel (unsigned char level)
void setProtectedLogin (unsigned char protectedLogin)
void setBuildType (unsigned char buildType)
void setSrcAddr (unsigned int srcAddr)
void setSrcPort (unsigned short srcPort)
void setReserved (unsigned short reserved)
void setClientKey (const plString &clientKey)
- 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:
kAcctUuid 
kPlayerID 
kTempPlayerID 
kCCRLevel 
kProtectedLogin 
kBuildType 
kPlayerName 
kSrcAddr 
kSrcPort 
kReserved 
kClientKey 

Constructor & Destructor Documentation

plClientGuid::plClientGuid ( )

Member Function Documentation

plUuid plClientGuid::getAcctUuid ( ) const
unsigned char plClientGuid::getBuildType ( ) const
unsigned char plClientGuid::getCCRLevel ( ) const
plString plClientGuid::getClientKey ( ) const
unsigned short plClientGuid::getFlags ( ) const
unsigned int plClientGuid::getPlayerID ( ) const
plString plClientGuid::getPlayerName ( ) const
unsigned char plClientGuid::getProtectedLogin ( ) const
unsigned short plClientGuid::getReserved ( ) const
unsigned int plClientGuid::getSrcAddr ( ) const
unsigned short plClientGuid::getSrcPort ( ) const
virtual void plClientGuid::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 plCreatable.

virtual void plClientGuid::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().

Implements plCreatable.

virtual void plClientGuid::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 plCreatable.

void plClientGuid::setAcctUuid ( const plUuid acctUuid)
void plClientGuid::setBuildType ( unsigned char  buildType)
void plClientGuid::setCCRLevel ( unsigned char  level)
void plClientGuid::setClientKey ( const plString clientKey)
void plClientGuid::setFlags ( unsigned short  flags)
void plClientGuid::setPlayerID ( unsigned int  playerID)
void plClientGuid::setPlayerName ( const plString playerName)
void plClientGuid::setProtectedLogin ( unsigned char  protectedLogin)
void plClientGuid::setReserved ( unsigned short  reserved)
void plClientGuid::setSrcAddr ( unsigned int  srcAddr)
void plClientGuid::setSrcPort ( unsigned short  srcPort)
virtual void plClientGuid::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 plCreatable.


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