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

#include <plAvBrainCoop.h>

Inheritance diagram for plAvBrainCoop:
plAvBrainGeneric plArmatureBrain plCreatable

Public Member Functions

 plAvBrainCoop ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< plKey > & getRecipients () const
std::vector< plKey > & getRecipients ()
void addRecipeient (plKey recp)
void delRecipient (size_t idx)
void clearRecipients ()
unsigned int getInitiatorID () const
unsigned short getInitiatorSerial () const
bool isWaitingForClick () const
plKey getHostKey () const
plKey getGuestKey () const
void setInitiatorID (unsigned int id)
void setInitiatorSerial (unsigned short serial)
void setWaitingForClick (bool waiting)
void setHostKey (plKey host)
void setGuestKey (plKey guest)
- Public Member Functions inherited from plAvBrainGeneric
 plAvBrainGeneric ()
virtual ~plAvBrainGeneric ()
const std::vector< plAnimStage * > & getStages () const
std::vector< plAnimStage * > & getStages ()
void addStage (plAnimStage *stage)
void delStage (size_t idx)
void clearStages ()
int getCurStage () const
BrainType getType () const
unsigned int getExitFlags () const
Mode getMode () const
bool isForward () const
plMessagegetStartMessage () const
plMessagegetEndMessage () const
float getFadeIn () const
float getFadeOut () const
MoveMode getMoveMode () const
plAGAnim::BodyUsage getBodyUsage () const
plKey getRecipient () const
void setCurStage (int stage)
void setType (BrainType type)
void setExitFlags (unsigned int flags)
void setMode (Mode mode)
void setForward (bool fwd)
void setFadeIn (float fade)
void setFadeOut (float fade)
void setMoveMode (MoveMode mode)
void setBodyUsage (plAGAnim::BodyUsage usage)
void setRecipient (plKey recp)
void setStartMessage (plMessage *msg)
void setEndMessage (plMessage *msg)
- Public Member Functions inherited from plArmatureBrain
 plArmatureBrain ()
- 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 plAvBrainGeneric
enum  BrainType {
  kGeneric, kLadder, kSit, kEmote,
  kAFK, kNumBrainTypes, kNonGeneric = kNumBrainTypes
}
enum  ExitFlag {
  kExitNormal = 0, kExitAnyTask = 0x1, kExitNewBrain = 0x2, kExitAnyInput = 0x4,
  kExitMaxFlag = 0x8
}
enum  MoveMode {
  kMoveAbsolute, kMoveRelative, kMoveNormal, kMoveStandstill,
  kMaxMoveMode
}
enum  Mode {
  kEntering = 1, kNormal, kFadingIn, kFadingOut,
  kExit, kAbort, kMaxMode
}

Constructor & Destructor Documentation

plAvBrainCoop::plAvBrainCoop ( )

Member Function Documentation

void plAvBrainCoop::addRecipeient ( plKey  recp)
void plAvBrainCoop::clearRecipients ( )
void plAvBrainCoop::delRecipient ( size_t  idx)
plKey plAvBrainCoop::getGuestKey ( ) const
plKey plAvBrainCoop::getHostKey ( ) const
unsigned int plAvBrainCoop::getInitiatorID ( ) const
unsigned short plAvBrainCoop::getInitiatorSerial ( ) const
const std::vector<plKey>& plAvBrainCoop::getRecipients ( ) const
std::vector<plKey>& plAvBrainCoop::getRecipients ( )
virtual void plAvBrainCoop::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 plAvBrainGeneric.

virtual void plAvBrainCoop::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 plAvBrainGeneric.

bool plAvBrainCoop::isWaitingForClick ( ) const
virtual void plAvBrainCoop::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 plAvBrainGeneric.

void plAvBrainCoop::setGuestKey ( plKey  guest)
void plAvBrainCoop::setHostKey ( plKey  host)
void plAvBrainCoop::setInitiatorID ( unsigned int  id)
void plAvBrainCoop::setInitiatorSerial ( unsigned short  serial)
void plAvBrainCoop::setWaitingForClick ( bool  waiting)
virtual void plAvBrainCoop::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 plAvBrainGeneric.


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