plAGAnim Class Reference

#include <plAGAnim.h>

Inheritance diagram for plAGAnim:

Public Types
enum	BodyUsage {   kBodyUnknown, kBodyUpper, kBodyFull, kBodyLower,   kBodyMax }
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 }

Public Member Functions
	plAGAnim ()
virtual	~plAGAnim ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const std::vector < plAGApplicator * > &	getApplicators () const
std::vector< plAGApplicator * > &	getApplicators ()
void	addApplicator (plAGApplicator *app)
void	delApplicator (size_t idx)
void	clearApplicators ()
float	getBlend () const
float	getStart () const
float	getEnd () const
plString	getName () const
void	setBlend (float blend)
void	setStart (float start)
void	setEnd (float end)
void	setName (const plString &name)
Public Member Functions inherited from plSynchedObject
	plSynchedObject ()
int	getFlags () const
void	setFlags (int flags)
const std::vector< plString > &	getExcludes () const
const std::vector< plString > &	getVolatiles () const
void	setExclude (const plString &sdl)
void	setVolatile (const plString &sdl)
void	clearExcludes ()
void	clearVolatiles ()
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
plKey	getKey () const
void	setKey (plKey key)
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
virtual void	IPrcWrite (pfPrcHelper *prc)
virtual void	IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes
std::vector< plAGApplicator * >	fApps
float	fBlend
float	fStart
float	fEnd
plString	fName
unsigned char	fEoaFlag
Protected Attributes inherited from plSynchedObject
unsigned int	fSynchFlags
std::vector< plString >	fSDLExcludeList
std::vector< plString >	fSDLVolatileList

Member Enumeration Documentation

enum plAGAnim::BodyUsage

Enumerator:

kBodyUnknown
kBodyUpper
kBodyFull
kBodyLower
kBodyMax

Constructor & Destructor Documentation

plAGAnim::plAGAnim

(

)

virtual plAGAnim::~plAGAnim ( )

virtual

Member Function Documentation

void plAGAnim::addApplicator

(

plAGApplicator *

app

)

void plAGAnim::clearApplicators

(

)

void plAGAnim::delApplicator

(

size_t

idx

)

const std::vector<plAGApplicator*>& plAGAnim::getApplicators

(

)

const

std::vector<plAGApplicator*>& plAGAnim::getApplicators

(

)

float plAGAnim::getBlend

(

)

const

float plAGAnim::getEnd

(

)

const

plString plAGAnim::getName

(

)

const

float plAGAnim::getStart

(

)

const

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

Reimplemented in plAGAnimBink, plEmoteAnim, plAgeGlobalAnim, and plATCAnim.

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

Reimplemented in plAGAnimBink, plEmoteAnim, plAgeGlobalAnim, and plATCAnim.

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

Reimplemented in plAGAnimBink, plEmoteAnim, plAgeGlobalAnim, and plATCAnim.

void plAGAnim::setBlend

(

float

blend

)

void plAGAnim::setEnd

(

float

end

)

void plAGAnim::setName

(

const plString &

name

)

void plAGAnim::setStart

(

float

start

)

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

Reimplemented in plAGAnimBink, plEmoteAnim, plAgeGlobalAnim, and plATCAnim.

Member Data Documentation

std::vector<plAGApplicator*> plAGAnim::fApps

protected

float plAGAnim::fBlend

protected

float plAGAnim::fEnd

protected

unsigned char plAGAnim::fEoaFlag

protected

plString plAGAnim::fName

protected

float plAGAnim::fStart

protected

---

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

• core/PRP/Avatar/plAGAnim.h