libHSPlasma
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
plAgeLinkStruct Class Reference

#include <plAgeLinkInfo.h>

Inheritance diagram for plAgeLinkStruct:
plCreatable

Public Types

enum  {
  kHasAgeInfo = 0x1, kHasLinkingRules = 0x2, kHasSpawnPt_DEAD = 0x4, kHasSpawnPt_DEAD2 = 0x8,
  kHasAmCCR = 0x10, kHasSpawnPt = 0x20, kHasParentAgeFilename = 0x40
}
enum  LinkingRules {
  kBasicLink, kOriginalBook, kSubAgeBook, kOwnedBook,
  kVisitBook, kChildAgeBook
}

Public Member Functions

 plAgeLinkStruct ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)
bool isEmpty ()
void clear ()
const plAgeInfoStructgetAgeInfo () const
plAgeInfoStructgetAgeInfo ()
const plSpawnPointInfogetSpawnPoint () const
plSpawnPointInfogetSpawnPoint ()
signed char getLinkingRules () const
unsigned char getAmCCR () const
plString getParentAgeFilename () const
void setLinkingRules (signed char rules)
void setAmCCR (unsigned char ccr)
void setParentAgeFilename (plString filename)
void setHasAgeInfo (bool has)
void setHasSpawnPoint (bool has)
void clearLinkingRules ()
void clearAmCCR ()
void clearParentAgeFilename ()
bool hasAgeInfo () const
bool hasLinkingRules () const
bool hasAmCCR () const
bool hasSpawnPoint () const
bool hasParentAgeFilename () const
- 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)

Static Public Attributes

static const char * kLinkingRuleNames []

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

unsigned short fFlags
signed char fLinkingRules
unsigned char fAmCCR
plAgeInfoStruct fAgeInfo
plSpawnPointInfo fSpawnPoint
plString fParentAgeFilename

Member Enumeration Documentation

anonymous enum
Enumerator:
kHasAgeInfo 
kHasLinkingRules 
kHasSpawnPt_DEAD 
kHasSpawnPt_DEAD2 
kHasAmCCR 
kHasSpawnPt 
kHasParentAgeFilename 
Enumerator:
kBasicLink 

Link to public age; Don't remember this link in KI/Vault

kOriginalBook 

Link and create a book in the AgesIOwn folder

kSubAgeBook 

Link to a sub age of current age

kOwnedBook 

Link using info from my AgesIOwn folder

kVisitBook 

Link using info from my AgesICanVisit folder

kChildAgeBook 

Link to a child age of current age

Constructor & Destructor Documentation

plAgeLinkStruct::plAgeLinkStruct ( )

Member Function Documentation

void plAgeLinkStruct::clear ( )
void plAgeLinkStruct::clearAmCCR ( )
void plAgeLinkStruct::clearLinkingRules ( )
void plAgeLinkStruct::clearParentAgeFilename ( )
const plAgeInfoStruct& plAgeLinkStruct::getAgeInfo ( ) const
plAgeInfoStruct& plAgeLinkStruct::getAgeInfo ( )
unsigned char plAgeLinkStruct::getAmCCR ( ) const
signed char plAgeLinkStruct::getLinkingRules ( ) const
plString plAgeLinkStruct::getParentAgeFilename ( ) const
const plSpawnPointInfo& plAgeLinkStruct::getSpawnPoint ( ) const
plSpawnPointInfo& plAgeLinkStruct::getSpawnPoint ( )
bool plAgeLinkStruct::hasAgeInfo ( ) const
bool plAgeLinkStruct::hasAmCCR ( ) const
bool plAgeLinkStruct::hasLinkingRules ( ) const
bool plAgeLinkStruct::hasParentAgeFilename ( ) const
bool plAgeLinkStruct::hasSpawnPoint ( ) const
virtual void plAgeLinkStruct::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.

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

bool plAgeLinkStruct::isEmpty ( )
virtual void plAgeLinkStruct::prcParse ( const pfPrcTag tag,
plResManager mgr 
)
virtual

Read this creatable from a PRC tag. If any keys are parsed, they will be added to the plResManager automatically.

Reimplemented from plCreatable.

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

void plAgeLinkStruct::setAmCCR ( unsigned char  ccr)
void plAgeLinkStruct::setHasAgeInfo ( bool  has)
void plAgeLinkStruct::setHasSpawnPoint ( bool  has)
void plAgeLinkStruct::setLinkingRules ( signed char  rules)
void plAgeLinkStruct::setParentAgeFilename ( plString  filename)
virtual void plAgeLinkStruct::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.

Member Data Documentation

plAgeInfoStruct plAgeLinkStruct::fAgeInfo
protected
unsigned char plAgeLinkStruct::fAmCCR
protected
unsigned short plAgeLinkStruct::fFlags
protected
signed char plAgeLinkStruct::fLinkingRules
protected
plString plAgeLinkStruct::fParentAgeFilename
protected
plSpawnPointInfo plAgeLinkStruct::fSpawnPoint
protected
const char* plAgeLinkStruct::kLinkingRuleNames[]
static

Textual name lookup for linking rule types


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