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

#include <plAvBrainGeneric.h>

Inheritance diagram for plAvBrainGeneric:
plArmatureBrain plCreatable plAvBrainCoop

Public Types

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
}

Public Member Functions

 plAvBrainGeneric ()
virtual ~plAvBrainGeneric ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
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)

Member Enumeration Documentation

Enumerator:
kGeneric 
kLadder 
kSit 
kEmote 
kAFK 
kNumBrainTypes 
kNonGeneric 
Enumerator:
kExitNormal 
kExitAnyTask 
kExitNewBrain 
kExitAnyInput 
kExitMaxFlag 
Enumerator:
kEntering 
kNormal 
kFadingIn 
kFadingOut 
kExit 
kAbort 
kMaxMode 
Enumerator:
kMoveAbsolute 
kMoveRelative 
kMoveNormal 
kMoveStandstill 
kMaxMoveMode 

Constructor & Destructor Documentation

plAvBrainGeneric::plAvBrainGeneric ( )
virtual plAvBrainGeneric::~plAvBrainGeneric ( )
virtual

Member Function Documentation

void plAvBrainGeneric::addStage ( plAnimStage stage)
void plAvBrainGeneric::clearStages ( )
void plAvBrainGeneric::delStage ( size_t  idx)
plAGAnim::BodyUsage plAvBrainGeneric::getBodyUsage ( ) const
int plAvBrainGeneric::getCurStage ( ) const
plMessage* plAvBrainGeneric::getEndMessage ( ) const
unsigned int plAvBrainGeneric::getExitFlags ( ) const
float plAvBrainGeneric::getFadeIn ( ) const
float plAvBrainGeneric::getFadeOut ( ) const
Mode plAvBrainGeneric::getMode ( ) const
MoveMode plAvBrainGeneric::getMoveMode ( ) const
plKey plAvBrainGeneric::getRecipient ( ) const
const std::vector<plAnimStage*>& plAvBrainGeneric::getStages ( ) const
std::vector<plAnimStage*>& plAvBrainGeneric::getStages ( )
plMessage* plAvBrainGeneric::getStartMessage ( ) const
BrainType plAvBrainGeneric::getType ( ) const
virtual void plAvBrainGeneric::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.

Reimplemented in plAvBrainCoop.

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

Reimplemented in plAvBrainCoop.

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

Reimplemented in plAvBrainCoop.

void plAvBrainGeneric::setBodyUsage ( plAGAnim::BodyUsage  usage)
void plAvBrainGeneric::setCurStage ( int  stage)
void plAvBrainGeneric::setEndMessage ( plMessage msg)
void plAvBrainGeneric::setExitFlags ( unsigned int  flags)
void plAvBrainGeneric::setFadeIn ( float  fade)
void plAvBrainGeneric::setFadeOut ( float  fade)
void plAvBrainGeneric::setForward ( bool  fwd)
void plAvBrainGeneric::setMode ( Mode  mode)
void plAvBrainGeneric::setMoveMode ( MoveMode  mode)
void plAvBrainGeneric::setRecipient ( plKey  recp)
void plAvBrainGeneric::setStartMessage ( plMessage msg)
void plAvBrainGeneric::setType ( BrainType  type)
virtual void plAvBrainGeneric::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 plArmatureBrain.

Reimplemented in plAvBrainCoop.


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