plResponderModifier Class Reference

#include <plResponderModifier.h>

Inheritance diagram for plResponderModifier:

Classes
class	plResponderCmd
class	plResponderState

Public Types
enum	{ kDetectTrigger = 0x1, kDetectUnTrigger = 0x2, kSkipFFSound = 0x4 }

Public Member Functions
	plResponderModifier ()
virtual	~plResponderModifier ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const std::vector < plResponderState * > &	getStates () const
std::vector< plResponderState * > &	getStates ()
void	addState (plResponderState *state)
void	delState (size_t idx)
void	clearStates ()
bool	isEnabled () const
signed char	getCurState () const
unsigned char	getFlags () const
void	setEnabled (bool enabled)
void	setCurState (signed char state)
void	setFlags (unsigned char flags)
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
std::vector< plResponderState * >	fStates
signed char	fCurState
bool	fEnabled
unsigned char	fFlags
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Member Enumeration Documentation

anonymous enum

Enumerator:

kDetectTrigger
kDetectUnTrigger
kSkipFFSound

Constructor & Destructor Documentation

plResponderModifier::plResponderModifier

(

)

virtual plResponderModifier::~plResponderModifier ( )

virtual

Member Function Documentation

void plResponderModifier::addState

(

plResponderState *

state

)

void plResponderModifier::clearStates

(

)

void plResponderModifier::delState

(

size_t

idx

)

signed char plResponderModifier::getCurState

(

)

const

unsigned char plResponderModifier::getFlags

(

)

const

Reimplemented from plSynchedObject.

const std::vector<plResponderState*>& plResponderModifier::getStates

(

)

const

std::vector<plResponderState*>& plResponderModifier::getStates

(

)

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

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

bool plResponderModifier::isEnabled

(

)

const

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

void plResponderModifier::setCurState

(

signed char

state

)

void plResponderModifier::setEnabled

(

bool

enabled

)

void plResponderModifier::setFlags

(

unsigned char

flags

)

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

Member Data Documentation

signed char plResponderModifier::fCurState

protected

bool plResponderModifier::fEnabled

protected

unsigned char plResponderModifier::fFlags

protected

std::vector<plResponderState*> plResponderModifier::fStates

protected

---

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

• core/PRP/Modifier/plResponderModifier.h