plSimpleRegionSensor Class Reference

#include <plSimpleRegionSensor.h>

Inheritance diagram for plSimpleRegionSensor:

Public Member Functions
	plSimpleRegionSensor ()
virtual	~plSimpleRegionSensor ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
void	setEnterMsg (plMessage *msg)
void	setExitMsg (plMessage *msg)
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
plMessage *	fEnterMsg
plMessage *	fExitMsg
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Additional Inherited Members
Public Types inherited from plSynchedObject
enum	Flags {   kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8,   kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40,   kAllStateIsVolatile = 0x80 }
enum	SDLSendFlags {   kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8,   kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80 }

Constructor & Destructor Documentation

plSimpleRegionSensor::plSimpleRegionSensor

(

)

virtual plSimpleRegionSensor::~plSimpleRegionSensor ( )

virtual

Member Function Documentation

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

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

virtual void plSimpleRegionSensor::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 plAutoWalkRegion, and plSwimDetector.

void plSimpleRegionSensor::setEnterMsg

(

plMessage *

msg

)

void plSimpleRegionSensor::setExitMsg

(

plMessage *

msg

)

virtual void plSimpleRegionSensor::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 plAutoWalkRegion, and plSwimDetector.

Member Data Documentation

plMessage* plSimpleRegionSensor::fEnterMsg

protected

plMessage* plSimpleRegionSensor::fExitMsg

protected

---

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

• core/PRP/Region/plSimpleRegionSensor.h