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

#include <plLinkEffectsTriggerMsg.h>

Inheritance diagram for plLinkEffectsTriggerMsg:
plMessage plCreatable

Public Member Functions

 plLinkEffectsTriggerMsg ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
unsigned int getInvisLevel () const
unsigned int getEffects () const
bool isLeavingAge () const
plKey getLinkKey () const
plKey getLinkInAnimKey () const
void setInvisLevel (unsigned int level)
void setEffects (unsigned int effects)
void setLeavingAge (bool leaving)
void setLinkKey (plKey linkKey)
void setLinkInAnimKey (plKey animKey)
- 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 Member Functions inherited from plMessage
void IMsgRead (hsStream *S, plResManager *mgr)
void IMsgWrite (hsStream *S, plResManager *mgr)

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
}
- Protected Attributes inherited from plMessage
plKey fSender
std::vector< plKeyfReceivers
double fTimeStamp
unsigned int fBCastFlags

Constructor & Destructor Documentation

plLinkEffectsTriggerMsg::plLinkEffectsTriggerMsg ( )

Member Function Documentation

unsigned int plLinkEffectsTriggerMsg::getEffects ( ) const
unsigned int plLinkEffectsTriggerMsg::getInvisLevel ( ) const
plKey plLinkEffectsTriggerMsg::getLinkInAnimKey ( ) const
plKey plLinkEffectsTriggerMsg::getLinkKey ( ) const
virtual void plLinkEffectsTriggerMsg::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 plMessage.

virtual void plLinkEffectsTriggerMsg::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 plMessage.

bool plLinkEffectsTriggerMsg::isLeavingAge ( ) const
virtual void plLinkEffectsTriggerMsg::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 plMessage.

void plLinkEffectsTriggerMsg::setEffects ( unsigned int  effects)
void plLinkEffectsTriggerMsg::setInvisLevel ( unsigned int  level)
void plLinkEffectsTriggerMsg::setLeavingAge ( bool  leaving)
void plLinkEffectsTriggerMsg::setLinkInAnimKey ( plKey  animKey)
void plLinkEffectsTriggerMsg::setLinkKey ( plKey  linkKey)
virtual void plLinkEffectsTriggerMsg::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 plMessage.


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