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

#include <plAgeInfo.h>

Classes

struct  PageEntry

Public Types

enum  CommonPages { kTextures, kGlobal, kNumCommonPages }
enum  LoadFlags {
  kPreventAutoLoad = 0x1, kLoadIfSDLPresent = 0x2, kDontLoadMask = (kPreventAutoLoad | kLoadIfSDLPresent), kIsLocalOnly = 0x4,
  kIsVolatile = 0x8
}

Public Member Functions

 plAgeInfo ()
void readFromFile (const plString &filename)
void writeToFile (const plString &filename, PlasmaVer ver)
void prcWrite (pfPrcHelper *prc)
void prcParse (const pfPrcTag *tag)
plString getAgeName () const
unsigned int getStartDateTime () const
float getDayLength () const
short getMaxCapacity () const
short getLingerTime () const
int getSeqPrefix () const
unsigned int getReleaseVersion () const
void setAgeName (const plString &name)
void setStartDateTime (unsigned int time)
void setDayLength (float length)
void setMaxCapacity (short maxCap)
void setLingerTime (short time)
void setSeqPrefix (int prefix)
void setReleaseVersion (unsigned int ver)
size_t getNumPages () const
PageEntry getPage (size_t idx) const
void setPage (size_t idx, const PageEntry &page)
void addPage (const PageEntry &page)
void clearPages ()
size_t getNumCommonPages (PlasmaVer pv) const
PageEntry getCommonPage (size_t idx, PlasmaVer pv) const
plString getPageFilename (size_t idx, PlasmaVer pv) const
plString getCommonPageFilename (size_t idx, PlasmaVer pv) const
plLocation getPageLoc (size_t idx, PlasmaVer pv) const
plLocation getCommonPageLoc (size_t idx, PlasmaVer pv) const
std::vector< plLocationgetPageLocs (PlasmaVer pv, bool all=false) const

Static Public Attributes

static const plString kCommonPages [kNumCommonPages]

Protected Attributes

plString fName
unsigned int fStartDateTime
float fDayLength
short fMaxCapacity
short fLingerTime
int fSeqPrefix
unsigned int fReleaseVersion
std::vector< PageEntryfPages

Member Enumeration Documentation

Enumerator:
kTextures 
kGlobal 
kNumCommonPages 
Enumerator:
kPreventAutoLoad 
kLoadIfSDLPresent 
kDontLoadMask 
kIsLocalOnly 
kIsVolatile 

Constructor & Destructor Documentation

plAgeInfo::plAgeInfo ( )

Member Function Documentation

void plAgeInfo::addPage ( const PageEntry page)
void plAgeInfo::clearPages ( )
plString plAgeInfo::getAgeName ( ) const
PageEntry plAgeInfo::getCommonPage ( size_t  idx,
PlasmaVer  pv 
) const
plString plAgeInfo::getCommonPageFilename ( size_t  idx,
PlasmaVer  pv 
) const
plLocation plAgeInfo::getCommonPageLoc ( size_t  idx,
PlasmaVer  pv 
) const
float plAgeInfo::getDayLength ( ) const
short plAgeInfo::getLingerTime ( ) const
short plAgeInfo::getMaxCapacity ( ) const
size_t plAgeInfo::getNumCommonPages ( PlasmaVer  pv) const
size_t plAgeInfo::getNumPages ( ) const
PageEntry plAgeInfo::getPage ( size_t  idx) const
plString plAgeInfo::getPageFilename ( size_t  idx,
PlasmaVer  pv 
) const
plLocation plAgeInfo::getPageLoc ( size_t  idx,
PlasmaVer  pv 
) const
std::vector<plLocation> plAgeInfo::getPageLocs ( PlasmaVer  pv,
bool  all = false 
) const
unsigned int plAgeInfo::getReleaseVersion ( ) const
int plAgeInfo::getSeqPrefix ( ) const
unsigned int plAgeInfo::getStartDateTime ( ) const
void plAgeInfo::prcParse ( const pfPrcTag tag)
void plAgeInfo::prcWrite ( pfPrcHelper prc)
void plAgeInfo::readFromFile ( const plString filename)
void plAgeInfo::setAgeName ( const plString name)
void plAgeInfo::setDayLength ( float  length)
void plAgeInfo::setLingerTime ( short  time)
void plAgeInfo::setMaxCapacity ( short  maxCap)
void plAgeInfo::setPage ( size_t  idx,
const PageEntry page 
)
void plAgeInfo::setReleaseVersion ( unsigned int  ver)
void plAgeInfo::setSeqPrefix ( int  prefix)
void plAgeInfo::setStartDateTime ( unsigned int  time)
void plAgeInfo::writeToFile ( const plString filename,
PlasmaVer  ver 
)

Member Data Documentation

float plAgeInfo::fDayLength
protected
short plAgeInfo::fLingerTime
protected
short plAgeInfo::fMaxCapacity
protected
plString plAgeInfo::fName
protected
std::vector<PageEntry> plAgeInfo::fPages
protected
unsigned int plAgeInfo::fReleaseVersion
protected
int plAgeInfo::fSeqPrefix
protected
unsigned int plAgeInfo::fStartDateTime
protected
const plString plAgeInfo::kCommonPages[kNumCommonPages]
static

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