libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plOneShotMod Class Reference

#include <plOneShotMod.h>

Inheritance diagram for plOneShotMod:
plMultiModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Member Functions

 plOneShotMod ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plString getAnimName () const
bool isDrivable () const
bool isReversable () const
bool getSmartSeek () const
bool getNoSeek () const
float getSeekDuration ()
void setAnimName (const plString &name)
void setDrivable (bool drivable)
void setReversable (bool reversable)
void setSmartSeek (bool smartSeek)
void setNoSeek (bool noSeek)
void setSeekDuration (float duration)
- 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 fAnimName
bool fDrivable
bool fReversable
bool fSmartSeek
bool fNoSeek
float fSeekDuration
- Protected Attributes inherited from plMultiModifier
hsBitVector fFlags
std::vector< plKeyfTargets

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

plOneShotMod::plOneShotMod ( )

Member Function Documentation

plString plOneShotMod::getAnimName ( ) const
bool plOneShotMod::getNoSeek ( ) const
float plOneShotMod::getSeekDuration ( )
bool plOneShotMod::getSmartSeek ( ) const
virtual void plOneShotMod::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 plOneShotMod::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.

bool plOneShotMod::isDrivable ( ) const
bool plOneShotMod::isReversable ( ) const
virtual void plOneShotMod::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 plOneShotMod::setAnimName ( const plString name)
void plOneShotMod::setDrivable ( bool  drivable)
void plOneShotMod::setNoSeek ( bool  noSeek)
void plOneShotMod::setReversable ( bool  reversable)
void plOneShotMod::setSeekDuration ( float  duration)
void plOneShotMod::setSmartSeek ( bool  smartSeek)
virtual void plOneShotMod::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

plString plOneShotMod::fAnimName
protected
bool plOneShotMod::fDrivable
protected
bool plOneShotMod::fNoSeek
protected
bool plOneShotMod::fReversable
protected
float plOneShotMod::fSeekDuration
protected
bool plOneShotMod::fSmartSeek
protected

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