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 Attributes | Friends | List of all members
ProductionEntry Class Reference

#include <ProductionUpdate.h>

Inherits MemoryPoolObject.

Public Member Functions

 ProductionEntry (void)
 
const ThingTemplate * getProductionObject (void) const
 query what kind of thing is being produced by this entry
 
const UpgradeTemplate * getProductionUpgrade (void) const
 query what kind of upgrade is being produced by this entry
 
ProductionType getProductionType (void) const
 query the production type
 
Real getPercentComplete (void) const
 how much progress is done on this entry
 
ProductionID getProductionID (void) const
 get the unique (to the producer object) production ID
 
Int getProductionQuantity () const
 
Int getProductionQuantityRemaining () const
 
void oneProductionSuccessful ()
 
ExitDoorType getExitDoor () const
 
void setExitDoor (ExitDoorType exitDoor)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Protected Attributes

ProductionType m_type
 production type
 
union { 
 
   const ThingTemplate *   m_objectToProduce 
 what we're going to produce More...
 
   const UpgradeTemplate *   m_upgradeToResearch 
 what upgrade we're researching More...
 
};  
 
ProductionID m_productionID
 our very own production ID!
 
Real m_percentComplete
 percent our construction is complete
 
Int m_framesUnderConstruction
 counter for how many frames we've been under construction (incremented once per update)
 
Int m_productionQuantityTotal
 it is now possible to construct multiple units simultaneously.
 
Int m_productionQuantityProduced
 And we need to allow pausing within an entry, so we keep track of number of sub-successes.
 
ExitDoorType m_exitDoor
 
ProductionEntry * m_next
 next in list
 
ProductionEntry * m_prev
 prev in list
 

Friends

class ProductionUpdate
 

Additional Inherited Members

- 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

A ProductionEntry is a single entry representing something that we are supposed to produce

Definition at line 62 of file ProductionUpdate.h.

Constructor & Destructor Documentation

◆ ProductionEntry()

ProductionEntry::ProductionEntry ( void )

Definition at line 155 of file ProductionUpdate.cpp.

Member Function Documentation

◆ getExitDoor()

ExitDoorType ProductionEntry::getExitDoor ( ) const
inline

Definition at line 94 of file ProductionUpdate.h.

◆ getPercentComplete()

Real ProductionEntry::getPercentComplete ( void ) const
inline

how much progress is done on this entry

Definition at line 84 of file ProductionUpdate.h.

◆ getProductionID()

ProductionID ProductionEntry::getProductionID ( void ) const
inline

get the unique (to the producer object) production ID

Definition at line 87 of file ProductionUpdate.h.

◆ getProductionObject()

const ThingTemplate * ProductionEntry::getProductionObject ( void ) const
inline

query what kind of thing is being produced by this entry

Definition at line 75 of file ProductionUpdate.h.

◆ getProductionQuantity()

Int ProductionEntry::getProductionQuantity ( ) const
inline

Definition at line 89 of file ProductionUpdate.h.

◆ getProductionQuantityRemaining()

Int ProductionEntry::getProductionQuantityRemaining ( ) const
inline

Definition at line 90 of file ProductionUpdate.h.

◆ getProductionType()

ProductionType ProductionEntry::getProductionType ( void ) const
inline

query the production type

Definition at line 81 of file ProductionUpdate.h.

◆ getProductionUpgrade()

const UpgradeTemplate * ProductionEntry::getProductionUpgrade ( void ) const
inline

query what kind of upgrade is being produced by this entry

Definition at line 78 of file ProductionUpdate.h.

◆ oneProductionSuccessful()

void ProductionEntry::oneProductionSuccessful ( )
inline

Definition at line 92 of file ProductionUpdate.h.

◆ setExitDoor()

void ProductionEntry::setExitDoor ( ExitDoorType exitDoor)
inline

Definition at line 95 of file ProductionUpdate.h.

Friends And Related Symbol Documentation

◆ ProductionUpdate

friend class ProductionUpdate
friend

Definition at line 65 of file ProductionUpdate.h.

Member Data Documentation

◆ [union]

union { ... } ProductionEntry

◆ m_exitDoor

ExitDoorType ProductionEntry::m_exitDoor
protected

Definition at line 110 of file ProductionUpdate.h.

◆ m_framesUnderConstruction

Int ProductionEntry::m_framesUnderConstruction
protected

counter for how many frames we've been under construction (incremented once per update)

Definition at line 107 of file ProductionUpdate.h.

◆ m_next

ProductionEntry* ProductionEntry::m_next
protected

next in list

Definition at line 112 of file ProductionUpdate.h.

◆ m_objectToProduce

const ThingTemplate* ProductionEntry::m_objectToProduce

what we're going to produce

Definition at line 102 of file ProductionUpdate.h.

◆ m_percentComplete

Real ProductionEntry::m_percentComplete
protected

percent our construction is complete

Definition at line 106 of file ProductionUpdate.h.

◆ m_prev

ProductionEntry* ProductionEntry::m_prev
protected

prev in list

Definition at line 113 of file ProductionUpdate.h.

◆ m_productionID

ProductionID ProductionEntry::m_productionID
protected

our very own production ID!

Definition at line 105 of file ProductionUpdate.h.

◆ m_productionQuantityProduced

Int ProductionEntry::m_productionQuantityProduced
protected

And we need to allow pausing within an entry, so we keep track of number of sub-successes.

Definition at line 109 of file ProductionUpdate.h.

◆ m_productionQuantityTotal

Int ProductionEntry::m_productionQuantityTotal
protected

it is now possible to construct multiple units simultaneously.

Definition at line 108 of file ProductionUpdate.h.

◆ m_type

ProductionType ProductionEntry::m_type
protected

production type

Definition at line 99 of file ProductionUpdate.h.

◆ m_upgradeToResearch

const UpgradeTemplate* ProductionEntry::m_upgradeToResearch

what upgrade we're researching

Definition at line 103 of file ProductionUpdate.h.

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