plRandomCommandMod Class Reference

#include <plRandomCommandMod.h>

Inheritance diagram for plRandomCommandMod:

Public Types
enum	{   kNormal = 0, kNoRepeats = 0x1, kCoverall = 0x2, kOneCycle = 0x4,   kOneCmd = 0x8, kDelayFromEnd = 0x10, kSequential = 0x20 }
enum	{ kStopped = 0x1 }

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

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

Protected Attributes
unsigned char	fState
unsigned char	fMode
float	fMinDelay
float	fMaxDelay
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Member Enumeration Documentation

anonymous enum

Enumerator:

kNormal
kNoRepeats
kCoverall
kOneCycle
kOneCmd
kDelayFromEnd
kSequential

anonymous enum

Enumerator:

kStopped

Constructor & Destructor Documentation

plRandomCommandMod::plRandomCommandMod

(

)

Member Function Documentation

virtual void plRandomCommandMod::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 plSingleModifier.

Reimplemented in plRandomSoundMod.

virtual void plRandomCommandMod::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 plSingleModifier.

Reimplemented in plRandomSoundMod.

virtual void plRandomCommandMod::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 plSingleModifier.

Reimplemented in plRandomSoundMod.

virtual void plRandomCommandMod::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 plSingleModifier.

Reimplemented in plRandomSoundMod.

Member Data Documentation

float plRandomCommandMod::fMaxDelay

protected

float plRandomCommandMod::fMinDelay

protected

unsigned char plRandomCommandMod::fMode

protected

unsigned char plRandomCommandMod::fState

protected

---

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

• core/PRP/Modifier/plRandomCommandMod.h