plPythonFileMod Class Reference

#include <plPythonFileMod.h>

Inheritance diagram for plPythonFileMod:

Public Types

enum

func_num {   kfunc_FirstUpdate, kfunc_Update, kfunc_Notify, kfunc_AtTimer,   kfunc_OnKeyEvent, kfunc_Load, kfunc_Save, kfunc_GUINotify,   kfunc_PageLoad, kfunc_ClothingUpdate, kfunc_KIMsg, kfunc_MemberUpdate,   kfunc_RemoteAvatarInfo, kfunc_RTChat, kfunc_VaultEvent, kfunc_AvatarPage,   kfunc_SDLNotify, kfunc_OwnershipNotify, kfunc_AgeVaultEvent, kfunc_Init,   kfunc_OnCCRMsg, kfunc_OnServerInitComplete, kfunc_OnVaultNotify, kfunc_OnDefaultKeyCaught,   kfunc_OnMarkerMsg, kfunc_OnBackdoorMsg, kfunc_OnBehaviorNotify, kfunc_OnLOSNotify,   kfunc_OnBeginAgeLoad, kfunc_OnMovieEvent, kfunc_OnScreenCaptureDone, kfunc_OnClimbingWallEvent,   kfunc_OnClimbingWallInit, kfunc_OnClimbBlockerEvent, kfunc_OnAvatarSpawn, kfunc_OnAccountUpdate,   kfunc_gotPublicAgeList, kfunc_OnGameMgrMsg, kfunc_OnGameCliMsg, kfunc_lastone }

Public Member Functions
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const plString &	getFilename () const
void	setFilename (const plString &filename)
const std::vector< plKey > &	getReceivers () const
std::vector< plKey > &	getReceivers ()
void	addReceiver (plKey rcvr)
void	delReceiver (size_t idx)
void	clearReceivers ()
const std::vector < plPythonParameter > &	getParameters () const
std::vector< plPythonParameter > &	getParameters ()
void	addParameter (const plPythonParameter &param)
void	delParameter (size_t idx)
void	clearParameters ()
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
plString	fPythonFile
std::vector< plKey >	fReceivers
std::vector< plPythonParameter >	fParameters
Protected Attributes inherited from plMultiModifier
hsBitVector	fFlags
std::vector< plKey >	fTargets

Member Enumeration Documentation

enum plPythonFileMod::func_num

Enumerator:

kfunc_FirstUpdate
kfunc_Update
kfunc_Notify
kfunc_AtTimer
kfunc_OnKeyEvent
kfunc_Load
kfunc_Save
kfunc_GUINotify
kfunc_PageLoad
kfunc_ClothingUpdate
kfunc_KIMsg
kfunc_MemberUpdate
kfunc_RemoteAvatarInfo
kfunc_RTChat
kfunc_VaultEvent
kfunc_AvatarPage
kfunc_SDLNotify
kfunc_OwnershipNotify
kfunc_AgeVaultEvent
kfunc_Init
kfunc_OnCCRMsg
kfunc_OnServerInitComplete
kfunc_OnVaultNotify
kfunc_OnDefaultKeyCaught
kfunc_OnMarkerMsg
kfunc_OnBackdoorMsg
kfunc_OnBehaviorNotify
kfunc_OnLOSNotify
kfunc_OnBeginAgeLoad
kfunc_OnMovieEvent
kfunc_OnScreenCaptureDone
kfunc_OnClimbingWallEvent
kfunc_OnClimbingWallInit
kfunc_OnClimbBlockerEvent
kfunc_OnAvatarSpawn
kfunc_OnAccountUpdate
kfunc_gotPublicAgeList
kfunc_OnGameMgrMsg
kfunc_OnGameCliMsg
kfunc_lastone

Member Function Documentation

void plPythonFileMod::addParameter

(

const plPythonParameter &

param

)

void plPythonFileMod::addReceiver

(

plKey

rcvr

)

void plPythonFileMod::clearParameters

(

)

void plPythonFileMod::clearReceivers

(

)

void plPythonFileMod::delParameter

(

size_t

idx

)

void plPythonFileMod::delReceiver

(

size_t

idx

)

const plString& plPythonFileMod::getFilename

(

)

const

const std::vector<plPythonParameter>& plPythonFileMod::getParameters

(

)

const

std::vector<plPythonParameter>& plPythonFileMod::getParameters

(

)

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

(

)

const

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

(

)

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

void plPythonFileMod::setFilename

(

const plString &

filename

)

virtual void plPythonFileMod::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<plPythonParameter> plPythonFileMod::fParameters

protected

plString plPythonFileMod::fPythonFile

protected

std::vector<plKey> plPythonFileMod::fReceivers

protected

---

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

• core/PRP/Modifier/plPythonFileMod.h