#include <SidesList.h>

Inherits MemoryPoolObject, and Snapshot.

Public Types
enum	{ UNLIMITED_REBUILDS =0xFFFFFFFF }

enum	{ MAX_RESOURCE_GATHERERS = 10 }

Public Member Functions
	BuildListInfo (void)

void	setNumRebuilds (UnsignedInt numRebuilds)

void	setNextBuildList (BuildListInfo *pNext)

void	setLocation (Coord3D loc)

void	setAngle (Real angle)

void	setInitiallyBuilt (Bool built)

void	setBuildingName (AsciiString name)

void	setScript (AsciiString script)

void	setHealth (Int health)

void	setWhiner (Bool whiner)

void	setUnsellable (Bool unsellable)

void	setRepairable (Bool repairable)

BuildListInfo *	getNext (void) const

AsciiString	getBuildingName (void) const
	Gets the name.

AsciiString	getTemplateName (void) const
	Gets the name.

void	setTemplateName (AsciiString name)

Int	getNumRebuilds (void)

void	decrementNumRebuilds (void)

void	incrementNumRebuilds (void)

const Coord3D *	getLocation (void) const

const Coord2D *	getRallyOffset (void) const

Real	getAngle (void) const

Bool	isInitiallyBuilt (void)

AsciiString	getScript (void)

Int	getHealth (void)

Bool	getWhiner (void)

Bool	getUnsellable (void)

Bool	getRepairable (void)

void	setRenderObj (RenderObjClass *pObj)

RenderObjClass *	getRenderObj (void)

void	setShadowObj (Shadow *pObj)

Shadow *	getShadowObj (void)

void	setSelected (Bool sel)

Bool	isSelected (void)

void	setObjectID (ObjectID objID)

ObjectID	getObjectID (void) const

void	setObjectTimestamp (UnsignedInt frame)

UnsignedInt	getObjectTimestamp (void) const

Bool	isBuildable (void)
	returns true if has enough rebuilds left to build again

Bool	isUnderConstruction (void)

void	setUnderConstruction (Bool construction)

void	markPriorityBuild (void)

Bool	isPriorityBuild (void)

Bool	isAutomaticBuild (void)

Bool	isSupplyBuilding (void)

void	setSupplyBuilding (Bool isSupply)

ObjectID	getGathererID (Int ndx)

void	setGathererID (Int ndx, ObjectID id)

Int	getDesiredGatherers (void)

void	setDesiredGatherers (Int desired)

Int	getCurrentGatherers (void)

void	setCurrentGatherers (Int cur)

BuildListInfo *	duplicate (void)

Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Public Member Functions inherited from Snapshot
	Snapshot (void)

	~Snapshot (void)

Static Public Member Functions
static void	parseStructure (INI ini, void instance, void , const void )

Protected Member Functions
virtual void	crc (Xfer *xfer)

virtual void	xfer (Xfer *xfer)

virtual void	loadPostProcess (void)

Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()

void *	operator new (size_t s)

void	operator delete (void *p)

virtual MemoryPool *	getObjectMemoryPool ()=0

Protected Attributes
AsciiString	m_buildingName
	The name of this building.

AsciiString	m_templateName
	The thing template name for this model's info.

Coord3D	m_location
	The location of the object.

Coord2D	m_rallyPointOffset
	Offset to the natural rally point.

Real	m_angle
	Initial orientation of the building.

Bool	m_isInitiallyBuilt
	Whether the building is built at the start of the game.

UnsignedInt	m_numRebuilds
	Number of rebuilds allowed.

BuildListInfo *	m_nextBuildList
	linked list.

AsciiString	m_script

Int	m_health

Bool	m_whiner

Bool	m_unsellable

Bool	m_repairable

Bool	m_automaticallyBuild
	If true, the ai will build. If false, script has to enable this.

RenderObjClass *	m_renderObj
	object that renders in the 3d scene.

Shadow *	m_shadowObj
	object that renders shadows in the 3d scane.

Bool	m_selected
	True if the obj is selected in the editor.

ObjectID	m_objectID
	the object on the map instantiated by this info

UnsignedInt	m_objectTimestamp
	frame when object was built

Bool	m_underConstruction
	True if being constructed by dozer.

ObjectID	m_resourceGatherers [MAX_RESOURCE_GATHERERS]
	gatherers for this supply center type building.

Bool	m_isSupplyBuilding
	Uses gatherers to get supplies.

Int	m_desiredGatherers
	Number of gatherers desired.

Int	m_currentGatherers
	Number of gatherers available.

Bool	m_priorityBuild
	Is priority build.

Detailed Description

This is a class that describes an entry in the build list.

Definition at line 250 of file SidesList.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
UNLIMITED_REBUILDS

Definition at line 265 of file SidesList.h.

◆ anonymous enum

anonymous enum

Enumerator
MAX_RESOURCE_GATHERERS

Definition at line 266 of file SidesList.h.

Constructor & Destructor Documentation

◆ BuildListInfo()

BuildListInfo::BuildListInfo ( void )

BuildListInfo - Constructor.

Definition at line 910 of file SidesList.cpp.

Member Function Documentation

◆ crc()

void BuildListInfo::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements Snapshot.

Definition at line 1012 of file SidesList.cpp.

◆ decrementNumRebuilds()

void BuildListInfo::decrementNumRebuilds ( void )

inline

Definition at line 374 of file SidesList.h.

◆ duplicate()

BuildListInfo * BuildListInfo::duplicate ( void )

BuildListInfo - Duplicate - note - if linked, duplicates linked items.

Definition at line 991 of file SidesList.cpp.

◆ getAngle()

Real BuildListInfo::getAngle ( void ) const

inline

Definition at line 334 of file SidesList.h.

◆ getBuildingName()

AsciiString BuildListInfo::getBuildingName ( void ) const

inline

Gets the name.

Definition at line 326 of file SidesList.h.

◆ getCurrentGatherers()

Int BuildListInfo::getCurrentGatherers ( void )

inline

Definition at line 368 of file SidesList.h.

◆ getDesiredGatherers()

Int BuildListInfo::getDesiredGatherers ( void )

inline

Definition at line 366 of file SidesList.h.

◆ getGathererID()

ObjectID BuildListInfo::getGathererID ( Int ndx )

inline

Definition at line 364 of file SidesList.h.

◆ getHealth()

Int BuildListInfo::getHealth ( void )

inline

Definition at line 337 of file SidesList.h.

◆ getLocation()

const Coord3D * BuildListInfo::getLocation ( void ) const

inline

Definition at line 332 of file SidesList.h.

◆ getNext()

BuildListInfo * BuildListInfo::getNext ( void ) const

inline

Definition at line 325 of file SidesList.h.

◆ getNumRebuilds()

Int BuildListInfo::getNumRebuilds ( void )

inline

Definition at line 329 of file SidesList.h.

◆ getObjectID()

ObjectID BuildListInfo::getObjectID ( void ) const

inline

Definition at line 352 of file SidesList.h.

◆ getObjectTimestamp()

UnsignedInt BuildListInfo::getObjectTimestamp ( void ) const

inline

Definition at line 354 of file SidesList.h.

◆ getRallyOffset()

const Coord2D * BuildListInfo::getRallyOffset ( void ) const

inline

Definition at line 333 of file SidesList.h.

◆ getRenderObj()

RenderObjClass * BuildListInfo::getRenderObj ( void )

inline

Definition at line 343 of file SidesList.h.

◆ getRepairable()

Bool BuildListInfo::getRepairable ( void )

inline

Definition at line 340 of file SidesList.h.

◆ getScript()

AsciiString BuildListInfo::getScript ( void )

inline

Definition at line 336 of file SidesList.h.

◆ getShadowObj()

Shadow * BuildListInfo::getShadowObj ( void )

inline

Definition at line 345 of file SidesList.h.

◆ getTemplateName()

AsciiString BuildListInfo::getTemplateName ( void ) const

inline

Gets the name.

Definition at line 327 of file SidesList.h.

◆ getUnsellable()

Bool BuildListInfo::getUnsellable ( void )

inline

Definition at line 339 of file SidesList.h.

◆ getWhiner()

Bool BuildListInfo::getWhiner ( void )

inline

Definition at line 338 of file SidesList.h.

◆ incrementNumRebuilds()

void BuildListInfo::incrementNumRebuilds ( void )

inline

Definition at line 380 of file SidesList.h.

◆ isAutomaticBuild()

Bool BuildListInfo::isAutomaticBuild ( void )

inline

Definition at line 360 of file SidesList.h.

◆ isBuildable()

Bool BuildListInfo::isBuildable ( void )

inline

returns true if has enough rebuilds left to build again

Definition at line 386 of file SidesList.h.

◆ isInitiallyBuilt()

Bool BuildListInfo::isInitiallyBuilt ( void )

inline

Definition at line 335 of file SidesList.h.

◆ isPriorityBuild()

Bool BuildListInfo::isPriorityBuild ( void )

inline

Definition at line 359 of file SidesList.h.

◆ isSelected()

Bool BuildListInfo::isSelected ( void )

inline

Definition at line 348 of file SidesList.h.

◆ isSupplyBuilding()

Bool BuildListInfo::isSupplyBuilding ( void )

inline

Definition at line 362 of file SidesList.h.

◆ isUnderConstruction()

Bool BuildListInfo::isUnderConstruction ( void )

inline

Definition at line 356 of file SidesList.h.

◆ loadPostProcess()

void BuildListInfo::loadPostProcess ( void )

protectedvirtual

Load post process

Implements Snapshot.

Definition at line 1062 of file SidesList.cpp.

◆ markPriorityBuild()

void BuildListInfo::markPriorityBuild ( void )

inline

Definition at line 358 of file SidesList.h.

◆ parseStructure()

void BuildListInfo::parseStructure	(	INI *	ini,
		void *	instance,
		void *	,
		const void *	)

static

Definition at line 964 of file SidesList.cpp.

◆ setAngle()

void BuildListInfo::setAngle ( Real angle )

inline

Definition at line 315 of file SidesList.h.

◆ setBuildingName()

void BuildListInfo::setBuildingName ( AsciiString name )

inline

Definition at line 317 of file SidesList.h.

◆ setCurrentGatherers()

void BuildListInfo::setCurrentGatherers ( Int cur )

inline

Definition at line 369 of file SidesList.h.

◆ setDesiredGatherers()

void BuildListInfo::setDesiredGatherers ( Int desired )

inline

Definition at line 367 of file SidesList.h.

◆ setGathererID()

void BuildListInfo::setGathererID	(	Int	ndx,
		ObjectID	id )

inline

Definition at line 365 of file SidesList.h.

◆ setHealth()

void BuildListInfo::setHealth ( Int health )

inline

Definition at line 319 of file SidesList.h.

◆ setInitiallyBuilt()

void BuildListInfo::setInitiallyBuilt ( Bool built )

inline

Definition at line 316 of file SidesList.h.

◆ setLocation()

void BuildListInfo::setLocation ( Coord3D loc )

inline

Definition at line 314 of file SidesList.h.

◆ setNextBuildList()

void BuildListInfo::setNextBuildList ( BuildListInfo * pNext )

inline

Definition at line 313 of file SidesList.h.

◆ setNumRebuilds()

void BuildListInfo::setNumRebuilds ( UnsignedInt numRebuilds )

inline

Definition at line 312 of file SidesList.h.

◆ setObjectID()

void BuildListInfo::setObjectID ( ObjectID objID )

inline

Definition at line 351 of file SidesList.h.

◆ setObjectTimestamp()

void BuildListInfo::setObjectTimestamp ( UnsignedInt frame )

inline

Definition at line 353 of file SidesList.h.

◆ setRenderObj()

void BuildListInfo::setRenderObj ( RenderObjClass * pObj )

inline

Definition at line 342 of file SidesList.h.

◆ setRepairable()

void BuildListInfo::setRepairable ( Bool repairable )

inline

Definition at line 322 of file SidesList.h.

◆ setScript()

void BuildListInfo::setScript ( AsciiString script )

inline

Definition at line 318 of file SidesList.h.

◆ setSelected()

void BuildListInfo::setSelected ( Bool sel )

inline

Definition at line 347 of file SidesList.h.

◆ setShadowObj()

void BuildListInfo::setShadowObj ( Shadow * pObj )

inline

Definition at line 344 of file SidesList.h.

◆ setSupplyBuilding()

void BuildListInfo::setSupplyBuilding ( Bool isSupply )

inline

Definition at line 363 of file SidesList.h.

◆ setTemplateName()

void BuildListInfo::setTemplateName ( AsciiString name )

inline

Definition at line 328 of file SidesList.h.

◆ setUnderConstruction()

void BuildListInfo::setUnderConstruction ( Bool construction )

inline

Definition at line 357 of file SidesList.h.

◆ setUnsellable()

void BuildListInfo::setUnsellable ( Bool unsellable )

inline

Definition at line 321 of file SidesList.h.

◆ setWhiner()

void BuildListInfo::setWhiner ( Bool whiner )

inline

Definition at line 320 of file SidesList.h.

◆ xfer()

void BuildListInfo::xfer ( Xfer * xfer )

protectedvirtual

Xfer method Version Info: 1: Initial version

Implements Snapshot.

Definition at line 1022 of file SidesList.cpp.

Member Data Documentation

◆ m_angle

Real BuildListInfo::m_angle

protected

Initial orientation of the building.

Definition at line 283 of file SidesList.h.

◆ m_automaticallyBuild

Bool BuildListInfo::m_automaticallyBuild

protected

If true, the ai will build. If false, script has to enable this.

Definition at line 292 of file SidesList.h.

◆ m_buildingName

AsciiString BuildListInfo::m_buildingName

protected

The name of this building.

Definition at line 279 of file SidesList.h.

◆ m_currentGatherers

Int BuildListInfo::m_currentGatherers

protected

Number of gatherers available.

Definition at line 307 of file SidesList.h.

◆ m_desiredGatherers

Int BuildListInfo::m_desiredGatherers

protected

Number of gatherers desired.

Definition at line 306 of file SidesList.h.

◆ m_health

Int BuildListInfo::m_health

protected

Definition at line 288 of file SidesList.h.

◆ m_isInitiallyBuilt

Bool BuildListInfo::m_isInitiallyBuilt

protected

Whether the building is built at the start of the game.

Definition at line 284 of file SidesList.h.

◆ m_isSupplyBuilding

Bool BuildListInfo::m_isSupplyBuilding

protected

Uses gatherers to get supplies.

Definition at line 305 of file SidesList.h.

◆ m_location

Coord3D BuildListInfo::m_location

protected

The location of the object.

Definition at line 281 of file SidesList.h.

◆ m_nextBuildList

BuildListInfo* BuildListInfo::m_nextBuildList

protected

linked list.

Definition at line 286 of file SidesList.h.

◆ m_numRebuilds

UnsignedInt BuildListInfo::m_numRebuilds

protected

Number of rebuilds allowed.

Definition at line 285 of file SidesList.h.

◆ m_objectID

ObjectID BuildListInfo::m_objectID

protected

the object on the map instantiated by this info

Definition at line 301 of file SidesList.h.

◆ m_objectTimestamp

UnsignedInt BuildListInfo::m_objectTimestamp

protected

frame when object was built

Definition at line 302 of file SidesList.h.

◆ m_priorityBuild

Bool BuildListInfo::m_priorityBuild

protected

Is priority build.

Definition at line 308 of file SidesList.h.

◆ m_rallyPointOffset

Coord2D BuildListInfo::m_rallyPointOffset

protected

Offset to the natural rally point.

Definition at line 282 of file SidesList.h.

◆ m_renderObj

RenderObjClass* BuildListInfo::m_renderObj

protected

object that renders in the 3d scene.

Definition at line 296 of file SidesList.h.

◆ m_repairable

Bool BuildListInfo::m_repairable

protected

Definition at line 291 of file SidesList.h.

◆ m_resourceGatherers

ObjectID BuildListInfo::m_resourceGatherers[MAX_RESOURCE_GATHERERS]

protected

gatherers for this supply center type building.

Definition at line 304 of file SidesList.h.

◆ m_script

AsciiString BuildListInfo::m_script

protected

Definition at line 287 of file SidesList.h.

◆ m_selected

Bool BuildListInfo::m_selected

protected

True if the obj is selected in the editor.

Definition at line 298 of file SidesList.h.

◆ m_shadowObj

Shadow* BuildListInfo::m_shadowObj

protected

object that renders shadows in the 3d scane.

Definition at line 297 of file SidesList.h.

◆ m_templateName

AsciiString BuildListInfo::m_templateName

protected

The thing template name for this model's info.

Definition at line 280 of file SidesList.h.

◆ m_underConstruction

Bool BuildListInfo::m_underConstruction

protected

True if being constructed by dozer.

Definition at line 303 of file SidesList.h.

◆ m_unsellable

Bool BuildListInfo::m_unsellable

protected

Definition at line 290 of file SidesList.h.

◆ m_whiner

Bool BuildListInfo::m_whiner

protected

Definition at line 289 of file SidesList.h.

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

Code/GameEngine/Include/GameLogic/SidesList.h
Code/GameEngine/Source/GameLogic/Map/SidesList.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ BuildListInfo()

Member Function Documentation

◆ crc()

◆ decrementNumRebuilds()

◆ duplicate()

◆ getAngle()

◆ getBuildingName()

◆ getCurrentGatherers()

◆ getDesiredGatherers()

◆ getGathererID()

◆ getHealth()

◆ getLocation()

◆ getNext()

◆ getNumRebuilds()

◆ getObjectID()

◆ getObjectTimestamp()

◆ getRallyOffset()

◆ getRenderObj()

◆ getRepairable()

◆ getScript()

◆ getShadowObj()

◆ getTemplateName()

◆ getUnsellable()

◆ getWhiner()

◆ incrementNumRebuilds()

◆ isAutomaticBuild()

◆ isBuildable()

◆ isInitiallyBuilt()

◆ isPriorityBuild()

◆ isSelected()

◆ isSupplyBuilding()

◆ isUnderConstruction()

◆ loadPostProcess()

◆ markPriorityBuild()

◆ parseStructure()

◆ setAngle()

◆ setBuildingName()

◆ setCurrentGatherers()

◆ setDesiredGatherers()

◆ setGathererID()

◆ setHealth()

◆ setInitiallyBuilt()

◆ setLocation()

◆ setNextBuildList()

◆ setNumRebuilds()

◆ setObjectID()

◆ setObjectTimestamp()

◆ setRenderObj()

◆ setRepairable()

◆ setScript()

◆ setSelected()

◆ setShadowObj()

◆ setSupplyBuilding()

◆ setTemplateName()

◆ setUnderConstruction()

◆ setUnsellable()

◆ setWhiner()

◆ xfer()

Member Data Documentation

◆ m_angle

◆ m_automaticallyBuild

◆ m_buildingName

◆ m_currentGatherers

◆ m_desiredGatherers

◆ m_health

◆ m_isInitiallyBuilt

◆ m_isSupplyBuilding

◆ m_location

◆ m_nextBuildList

◆ m_numRebuilds