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

#include <plPythonMod.h>

Inheritance diagram for plPythonMod:
plMultiModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Types

enum  func_num {
  kfunc_Init, kfunc_Update, kfunc_Notify, kfunc_AnimAtStart,
  kfunc_AnimAtStop, kfunc_AnimAtTime, kfunc_AnimAtReverse, kfunc_Collide,
  kfunc_AtTimer, kfunc_OnKeyEvent, kfunc_lastone
}

Public Member Functions

 plPythonMod ()
virtual ~plPythonMod ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
- Public Member Functions inherited from plMultiModifier
bool getFlag (size_t flag) const
void setFlag (size_t flag, bool value)
virtual size_t getTargetsCount () const
virtual plKey getTarget (size_t pos) const
virtual void addTarget (plKey target)
virtual void removeTarget (plKey target)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

unsigned char * fPythonCode
unsigned int fPythonSize
std::vector< plKeyfReceivers
std::vector< PY_NOTETRACKfAnimNotetracks
std::vector< PY_SOUND_IDXfSoundName2Idx
std::vector< PY_MATERIAL_ANIMfMaterialAnim
- Protected Attributes inherited from plMultiModifier
hsBitVector fFlags
std::vector< plKeyfTargets

Member Enumeration Documentation

Enumerator:
kfunc_Init 
kfunc_Update 
kfunc_Notify 
kfunc_AnimAtStart 
kfunc_AnimAtStop 
kfunc_AnimAtTime 
kfunc_AnimAtReverse 
kfunc_Collide 
kfunc_AtTimer 
kfunc_OnKeyEvent 
kfunc_lastone 

Constructor & Destructor Documentation

plPythonMod::plPythonMod ( )
virtual plPythonMod::~plPythonMod ( )
virtual

Member Function Documentation

virtual void plPythonMod::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 plMultiModifier.

virtual void plPythonMod::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 plMultiModifier.

virtual void plPythonMod::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 plMultiModifier.

virtual void plPythonMod::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 plMultiModifier.

Member Data Documentation

std::vector<PY_NOTETRACK> plPythonMod::fAnimNotetracks
protected
std::vector<PY_MATERIAL_ANIM> plPythonMod::fMaterialAnim
protected
unsigned char* plPythonMod::fPythonCode
protected
unsigned int plPythonMod::fPythonSize
protected
std::vector<plKey> plPythonMod::fReceivers
protected
std::vector<PY_SOUND_IDX> plPythonMod::fSoundName2Idx
protected

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