plMessage Class Reference

#include <plMessage.h>

Inheritance diagram for plMessage:

Public Types

enum

plBCastFlags {   kBCastNone = 0x0, kBCastByType = 0x1, kBCastUNUSED_0 = 0x2, kPropagateToChildren = 0x4,   kBCastByExactType = 0x8, kPropagateToModifiers = 0x10, kClearAfterBCast = 0x20, kNetPropagate = 0x40,   kNetSent = 0x80, kNetUseRelevanceRegions = 0x100, kNetForce = 0x200, kNetNonLocal = 0x400,   kLocalPropagate = 0x800, kNetNonDeterministic = 0x200, kMsgWatch = 0x1000, kNetStartCascade = 0x2000,   kNetAllowInterAge = 0x4000, kNetSendUnreliable = 0x8000, kCCRSendToAllPlayers = 0x10000, kNetCreatedRemotely = 0x20000 }

Public Member Functions
	plMessage ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
plKey	getSender () const
double	getTimeStamp () const
unsigned int	getBCastFlags () const
void	setSender (plKey sender)
void	setTimeStamp (double timestamp)
void	setBCastFlags (unsigned int flags)
const std::vector< plKey > &	getReceivers () const
std::vector< plKey > &	getReceivers ()
void	addReceiver (plKey receiver)
void	delReceiver (size_t idx)
void	clearReceivers ()
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
void	IMsgRead (hsStream *S, plResManager *mgr)
void	IMsgWrite (hsStream *S, plResManager *mgr)
virtual void	IPrcWrite (pfPrcHelper *prc)
virtual void	IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes
plKey	fSender
std::vector< plKey >	fReceivers
double	fTimeStamp
unsigned int	fBCastFlags

Member Enumeration Documentation

enum plMessage::plBCastFlags

Enumerator:

kBCastNone
kBCastByType
kBCastUNUSED_0
kPropagateToChildren
kBCastByExactType
kPropagateToModifiers
kClearAfterBCast
kNetPropagate
kNetSent
kNetUseRelevanceRegions
kNetForce
kNetNonLocal
kLocalPropagate
kNetNonDeterministic
kMsgWatch
kNetStartCascade
kNetAllowInterAge
kNetSendUnreliable
kCCRSendToAllPlayers
kNetCreatedRemotely

Constructor & Destructor Documentation

plMessage::plMessage

(

)

Member Function Documentation

void plMessage::addReceiver

(

plKey

receiver

)

void plMessage::clearReceivers

(

)

void plMessage::delReceiver

(

size_t

idx

)

unsigned int plMessage::getBCastFlags

(

)

const

const std::vector<plKey>& plMessage::getReceivers

(

)

const

std::vector<plKey>& plMessage::getReceivers

(

)

plKey plMessage::getSender

(

)

const

double plMessage::getTimeStamp

(

)

const

void plMessage::IMsgRead ( hsStream *  S, plResManager *  mgr  )

protected

void plMessage::IMsgWrite ( hsStream *  S, plResManager *  mgr  )

protected

virtual void plMessage::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 plAvTaskSeekDoneMsg, plResponderEnableMsg, plAvBrainGenericMsg, plCameraMsg, plEventCallbackSetupMsg, pfKIMsg, plAvOneShotMsg, plSubWorldMsg, plAvPushBrainMsg, plAvSeekMsg, plAvatarSetTypeMsg, plClimbMsg, plSoundMsg, plAnimCmdMsg, plNotifyMsg, plSimSuppressMsg, plAccountUpdateMsg, plLoadCloneMsg, plTransitionMsg, plInputIfaceMgrMsg, plLoadAvatarMsg, plConsoleMsg, plEnableMsg, plEventCallbackMsg, plExcludeRegionMsg, plLinkToAgeMsg, plOneShotMsg, plServerReplyMsg, plAvTaskMsg, plLinkEffectsTriggerMsg, plPseudoLinkEffectMsg, plArmatureEffectStateMsg, plMessageWithCallbacks, plRideAnimatedPhysMsg, plSwimMsg, plTimerCallbackMsg, and plAvatarInputStateMsg.

virtual void plMessage::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().

Implements plCreatable.

Reimplemented in plAvTaskSeekDoneMsg, plResponderEnableMsg, plAvBrainGenericMsg, plCameraMsg, plEventCallbackSetupMsg, pfKIMsg, plAvOneShotMsg, plAvatarStealthModeMsg, plSubWorldMsg, plAvPushBrainMsg, plAvSeekMsg, plAvatarSetTypeMsg, plClimbMsg, plSoundMsg, plAnimCmdMsg, plNotifyMsg, plSimSuppressMsg, plAccountUpdateMsg, plLoadCloneMsg, plTransitionMsg, plInputIfaceMgrMsg, plLoadAvatarMsg, plArmatureUpdateMsg, plConsoleMsg, plEnableMsg, plEventCallbackMsg, plExcludeRegionMsg, plLinkToAgeMsg, plOneShotMsg, plServerReplyMsg, plAvTaskMsg, plLinkEffectsTriggerMsg, plPseudoLinkEffectMsg, plArmatureEffectStateMsg, plMessageWithCallbacks, plRideAnimatedPhysMsg, plSwimMsg, plTimerCallbackMsg, and plAvatarInputStateMsg.

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

Reimplemented in plAvTaskSeekDoneMsg, plResponderEnableMsg, plAvBrainGenericMsg, plCameraMsg, plEventCallbackSetupMsg, pfKIMsg, plAvOneShotMsg, plLinkingMgrMsg, plAvatarStealthModeMsg, plSubWorldMsg, plAvPushBrainMsg, plAvSeekMsg, plAvatarSetTypeMsg, plClimbMsg, plSoundMsg, plAnimCmdMsg, plNotifyMsg, plSimSuppressMsg, plAccountUpdateMsg, plLoadCloneMsg, plTransitionMsg, plInputIfaceMgrMsg, plLoadAvatarMsg, plArmatureUpdateMsg, plConsoleMsg, plEnableMsg, plEventCallbackMsg, plExcludeRegionMsg, plLinkToAgeMsg, plOneShotMsg, plServerReplyMsg, plAvTaskMsg, plLinkEffectsTriggerMsg, plPseudoLinkEffectMsg, plArmatureEffectStateMsg, plMessageWithCallbacks, plRideAnimatedPhysMsg, plSwimMsg, plTimerCallbackMsg, and plAvatarInputStateMsg.

void plMessage::setBCastFlags

(

unsigned int

flags

)

void plMessage::setSender

(

plKey

sender

)

void plMessage::setTimeStamp

(

double

timestamp

)

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

Reimplemented in plAvTaskSeekDoneMsg, plResponderEnableMsg, plAvBrainGenericMsg, plCameraMsg, plEventCallbackSetupMsg, pfKIMsg, plAvOneShotMsg, plLinkingMgrMsg, plAvatarStealthModeMsg, plSubWorldMsg, plAvPushBrainMsg, plAvSeekMsg, plAvatarSetTypeMsg, plClimbMsg, plSoundMsg, plAnimCmdMsg, plNotifyMsg, plSimSuppressMsg, plAccountUpdateMsg, plLoadCloneMsg, plTransitionMsg, plInputIfaceMgrMsg, plLoadAvatarMsg, plArmatureUpdateMsg, plConsoleMsg, plEnableMsg, plEventCallbackMsg, plExcludeRegionMsg, plLinkToAgeMsg, plOneShotMsg, plServerReplyMsg, plAvTaskMsg, plLinkEffectsTriggerMsg, plPseudoLinkEffectMsg, plArmatureEffectStateMsg, plMessageWithCallbacks, plRideAnimatedPhysMsg, plSwimMsg, plTimerCallbackMsg, and plAvatarInputStateMsg.

Member Data Documentation

unsigned int plMessage::fBCastFlags

protected

std::vector<plKey> plMessage::fReceivers

protected

plKey plMessage::fSender

protected

double plMessage::fTimeStamp

protected

---

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

• core/PRP/Message/plMessage.h