libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plLoadAvatarMsg Class Reference

#include <plLoadAvatarMsg.h>

Inheritance diagram for plLoadAvatarMsg:
plLoadCloneMsg plMessage plCreatable

Public Member Functions

 plLoadAvatarMsg ()
virtual ~plLoadAvatarMsg ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
bool getIsPlayer () const
plKey getSpawnPoint () const
plAvTaskgetInitialTask () const
plString getUserStr () const
void setIsPlayer (bool isPlayer)
void setSpawnPoint (plKey spawnPoint)
void setUserStr (plString userStr)
void setInitialTask (plAvTask *InitialTask)
- Public Member Functions inherited from plLoadCloneMsg
 plLoadCloneMsg ()
virtual ~plLoadCloneMsg ()
plKey getCloneKey () const
plKey getRequestor () const
unsigned char getValidMsg () const
unsigned char getIsLoading () const
unsigned int getUserData () const
unsigned int getOriginatingPlayerID () const
plMessagegetTriggerMsg () const
void setCloneKey (plKey key)
void setRequestor (plKey key)
void setValidMsg (unsigned char validMsg)
void setIsLoading (unsigned char isLoading)
void setUserData (unsigned int userData)
void setOriginatingPlayerID (unsigned int playerID)
void setTriggerMsg (plMessage *TriggerMsg)
- Public Member Functions inherited from plMessage
 plMessage ()
plKey getSender () const
double getTimeStamp () const
unsigned int getBCastFlags () const
void setSender (plKey sender)
void setTimeStamp (double timestamp)
void setBCastFlags (unsigned int flags)
const std::vector< plKey > & getReceivers () const
std::vector< plKey > & getReceivers ()
void addReceiver (plKey receiver)
void delReceiver (size_t idx)
void clearReceivers ()
- 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)

Protected Attributes

bool fIsPlayer
plKey fSpawnPoint
plAvTaskfInitialTask
plString fUserStr
- Protected Attributes inherited from plLoadCloneMsg
plKey fCloneKey
plKey fRequestorKey
unsigned char fValidMsg
unsigned char fIsLoading
unsigned int fUserData
unsigned int fOriginatingPlayerID
plMessagefTriggerMsg
- Protected Attributes inherited from plMessage
plKey fSender
std::vector< plKeyfReceivers
double fTimeStamp
unsigned int fBCastFlags

Additional Inherited Members

- Public Types inherited from plMessage
enum  plBCastFlags {
  kBCastNone = 0x0, kBCastByType = 0x1, kBCastUNUSED_0 = 0x2, kPropagateToChildren = 0x4,
  kBCastByExactType = 0x8, kPropagateToModifiers = 0x10, kClearAfterBCast = 0x20, kNetPropagate = 0x40,
  kNetSent = 0x80, kNetUseRelevanceRegions = 0x100, kNetForce = 0x200, kNetNonLocal = 0x400,
  kLocalPropagate = 0x800, kNetNonDeterministic = 0x200, kMsgWatch = 0x1000, kNetStartCascade = 0x2000,
  kNetAllowInterAge = 0x4000, kNetSendUnreliable = 0x8000, kCCRSendToAllPlayers = 0x10000, kNetCreatedRemotely = 0x20000
}

Constructor & Destructor Documentation

plLoadAvatarMsg::plLoadAvatarMsg ( )
virtual plLoadAvatarMsg::~plLoadAvatarMsg ( )
virtual

Member Function Documentation

plAvTask* plLoadAvatarMsg::getInitialTask ( ) const
bool plLoadAvatarMsg::getIsPlayer ( ) const
plKey plLoadAvatarMsg::getSpawnPoint ( ) const
plString plLoadAvatarMsg::getUserStr ( ) const
virtual void plLoadAvatarMsg::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 plLoadCloneMsg.

virtual void plLoadAvatarMsg::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 plLoadCloneMsg.

virtual void plLoadAvatarMsg::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 plLoadCloneMsg.

void plLoadAvatarMsg::setInitialTask ( plAvTask InitialTask)
void plLoadAvatarMsg::setIsPlayer ( bool  isPlayer)
void plLoadAvatarMsg::setSpawnPoint ( plKey  spawnPoint)
void plLoadAvatarMsg::setUserStr ( plString  userStr)
virtual void plLoadAvatarMsg::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 plLoadCloneMsg.

Member Data Documentation

plAvTask* plLoadAvatarMsg::fInitialTask
protected
bool plLoadAvatarMsg::fIsPlayer
protected
plKey plLoadAvatarMsg::fSpawnPoint
protected
plString plLoadAvatarMsg::fUserStr
protected

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