Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
ObjectTypes Class Reference

#include <ObjectTypes.h>

Inherits MemoryPoolObject, and Snapshot.

Public Member Functions

 ObjectTypes ()
 
 ObjectTypes (const AsciiString &listName)
 
void addObjectType (const AsciiString &objectType)
 
void removeObjectType (const AsciiString &objectType)
 
const AsciiString & getListName () const
 
void setListName (const AsciiString &listName)
 
Bool isInSet (const AsciiString &objectType) const
 
Bool isInSet (const ThingTemplate *objectType) const
 
UnsignedInt getListSize (void) const
 
AsciiString getNthInList (Int index) const
 
Int prepForPlayerCounting (std::vector< const ThingTemplate * > &templates, std::vector< Int > &counts)
 
Bool canBuildAny (Player *player)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Protected Member Functions

virtual void crc (Xfer *xfer)
 run the "light" crc check on this data structure
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess ()
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Detailed Description

Definition at line 40 of file ObjectTypes.h.

Constructor & Destructor Documentation

◆ ObjectTypes() [1/2]

ObjectTypes::ObjectTypes ( )

Definition at line 40 of file ObjectTypes.cpp.

◆ ObjectTypes() [2/2]

ObjectTypes::ObjectTypes ( const AsciiString & listName)

Definition at line 46 of file ObjectTypes.cpp.

Member Function Documentation

◆ addObjectType()

void ObjectTypes::addObjectType ( const AsciiString & objectType)

Definition at line 52 of file ObjectTypes.cpp.

◆ canBuildAny()

Bool ObjectTypes::canBuildAny ( Player * player)

Definition at line 121 of file ObjectTypes.cpp.

◆ crc()

void ObjectTypes::crc ( Xfer * xfer)
protectedvirtual

run the "light" crc check on this data structure

Implements Snapshot.

Definition at line 135 of file ObjectTypes.cpp.

◆ getListName()

const AsciiString & ObjectTypes::getListName ( ) const

Definition at line 75 of file ObjectTypes.cpp.

◆ getListSize()

UnsignedInt ObjectTypes::getListSize ( void ) const
inline

Definition at line 78 of file ObjectTypes.h.

◆ getNthInList()

AsciiString ObjectTypes::getNthInList ( Int index) const
inline

Definition at line 81 of file ObjectTypes.h.

◆ isInSet() [1/2]

Bool ObjectTypes::isInSet ( const AsciiString & objectType) const

Definition at line 87 of file ObjectTypes.cpp.

◆ isInSet() [2/2]

Bool ObjectTypes::isInSet ( const ThingTemplate * objectType) const

Definition at line 94 of file ObjectTypes.cpp.

◆ loadPostProcess()

void ObjectTypes::loadPostProcess ( )
protectedvirtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements Snapshot.

Definition at line 205 of file ObjectTypes.cpp.

◆ prepForPlayerCounting()

Int ObjectTypes::prepForPlayerCounting ( std::vector< const ThingTemplate * > & templates,
std::vector< Int > & counts )

Definition at line 104 of file ObjectTypes.cpp.

◆ removeObjectType()

void ObjectTypes::removeObjectType ( const AsciiString & objectType)

Definition at line 62 of file ObjectTypes.cpp.

◆ setListName()

void ObjectTypes::setListName ( const AsciiString & listName)

Definition at line 81 of file ObjectTypes.cpp.

◆ xfer()

void ObjectTypes::xfer ( Xfer * xfer)
protectedvirtual

Version Info: 1: Initial version

Implements Snapshot.

Definition at line 145 of file ObjectTypes.cpp.

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