Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
TerrainRoadType Class Reference

#include <TerrainRoads.h>

Inherits MemoryPoolObject.

Public Member Functions

 TerrainRoadType (void)
 
AsciiString getName (void)
 
AsciiString getTexture (void)
 
Bool isBridge (void)
 
UnsignedInt getID (void)
 
Real getRoadWidth (void)
 
Real getRoadWidthInTexture (void)
 
Real getBridgeScale (void)
 
AsciiString getScaffoldObjectName (void)
 
AsciiString getScaffoldSupportObjectName (void)
 
RGBColor getRadarColor (void)
 
AsciiString getBridgeModel (void)
 
AsciiString getBridgeModelNameDamaged (void)
 
AsciiString getBridgeModelNameReallyDamaged (void)
 
AsciiString getBridgeModelNameBroken (void)
 
AsciiString getTextureDamaged (void)
 
AsciiString getTextureReallyDamaged (void)
 
AsciiString getTextureBroken (void)
 
AsciiString getTowerObjectName (BridgeTowerType tower)
 
AsciiString getDamageToSoundString (BodyDamageType state)
 
AsciiString getDamageToOCLString (BodyDamageType state, Int index)
 
AsciiString getDamageToFXString (BodyDamageType state, Int index)
 
AsciiString getRepairedToSoundString (BodyDamageType state)
 
AsciiString getRepairedToOCLString (BodyDamageType state, Int index)
 
AsciiString getRepairedToFXString (BodyDamageType state, Int index)
 
Real getTransitionEffectsHeight (void)
 
Int getNumFXPerType (void)
 
void friend_setName (AsciiString name)
 
void friend_setTexture (AsciiString texture)
 
void friend_setBridge (Bool isBridge)
 
void friend_setID (UnsignedInt id)
 
void friend_setNext (TerrainRoadType *next)
 
TerrainRoadTypefriend_getNext (void)
 
void friend_setRoadWidth (Real width)
 
void friend_setRoadWidthInTexture (Real width)
 
void friend_setBridgeScale (Real scale)
 
void friend_setScaffoldObjectName (AsciiString name)
 
void friend_setScaffoldSupportObjectName (AsciiString name)
 
void friend_setBridgeModelName (AsciiString name)
 
void friend_setBridgeModelNameDamaged (AsciiString name)
 
void friend_setBridgeModelNameReallyDamaged (AsciiString name)
 
void friend_setBridgeModelNameBroken (AsciiString name)
 
void friend_setTextureDamaged (AsciiString texture)
 
void friend_setTextureReallyDamaged (AsciiString texture)
 
void friend_setTextureBroken (AsciiString texture)
 
void friend_setTowerObjectName (BridgeTowerType tower, AsciiString name)
 
void friend_setDamageToSoundString (BodyDamageType state, AsciiString s)
 
void friend_setDamageToOCLString (BodyDamageType state, Int index, AsciiString s)
 
void friend_setDamageToFXString (BodyDamageType state, Int index, AsciiString s)
 
void friend_setRepairedToSoundString (BodyDamageType state, AsciiString s)
 
void friend_setRepairedToOCLString (BodyDamageType state, Int index, AsciiString s)
 
void friend_setRepairedToFXString (BodyDamageType state, Int index, AsciiString s)
 
void friend_setTransitionEffectsHeight (Real height)
 
void friend_setNumFXPerType (Int num)
 
const FieldParsegetRoadFieldParse (void)
 get the parsing table for INI
 
const FieldParsegetBridgeFieldParse (void)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Static Protected Member Functions

static void parseTransitionToOCL (INI *ini, void *instance, void *store, const void *userData)
 
static void parseTransitionToFX (INI *ini, void *instance, void *store, const void *userData)
 

Protected Attributes

AsciiString m_name
 entry name
 
Bool m_isBridge
 true if entry is for a bridge
 
UnsignedInt m_id
 unique id
 
TerrainRoadTypem_next
 next in road list
 
Real m_roadWidth
 width of road
 
Real m_roadWidthInTexture
 width of road in the texture
 
Real m_bridgeScale
 scale for bridge
 
AsciiString m_scaffoldObjectName
 scaffold object name
 
AsciiString m_scaffoldSupportObjectName
 scaffold support object name
 
RGBColor m_radarColor
 color for this bridge on the radar
 
AsciiString m_bridgeModelName
 model name for bridge
 
AsciiString m_texture
 texture filename
 
AsciiString m_bridgeModelNameDamaged
 model name for bridge
 
AsciiString m_textureDamaged
 model name for bridge
 
AsciiString m_bridgeModelNameReallyDamaged
 model name for bridge
 
AsciiString m_textureReallyDamaged
 model name for bridge
 
AsciiString m_bridgeModelNameBroken
 model name for bridge
 
AsciiString m_textureBroken
 model name for bridge
 
AsciiString m_towerObjectName [BRIDGE_MAX_TOWERS]
 object names for the targetable towers on the bridge
 
AsciiString m_damageToSoundString [BODYDAMAGETYPE_COUNT]
 
AsciiString m_damageToOCLString [BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
 
AsciiString m_damageToFXString [BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
 
AsciiString m_repairedToSoundString [BODYDAMAGETYPE_COUNT]
 
AsciiString m_repairedToOCLString [BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
 
AsciiString m_repairedToFXString [BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
 
Real m_transitionEffectsHeight
 
Int m_numFXPerType
 for each fx/ocl we will make this many of them on the bridge area
 

Static Protected Attributes

static const FieldParse m_terrainRoadFieldParseTable []
 the parse table for INI definition
 
static const FieldParse m_terrainBridgeFieldParseTable []
 the parse table for INI definition
 

Additional Inherited Members

- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPoolgetObjectMemoryPool ()=0
 

Detailed Description

Terrain road description, good for roads and bridges

Definition at line 64 of file TerrainRoads.h.

Constructor & Destructor Documentation

◆ TerrainRoadType()

TerrainRoadType::TerrainRoadType ( void )

Definition at line 207 of file TerrainRoads.cpp.

Member Function Documentation

◆ friend_getNext()

TerrainRoadType * TerrainRoadType::friend_getNext ( void )
inline

Definition at line 109 of file TerrainRoads.h.

◆ friend_setBridge()

void TerrainRoadType::friend_setBridge ( Bool isBridge)
inline

Definition at line 106 of file TerrainRoads.h.

◆ friend_setBridgeModelName()

void TerrainRoadType::friend_setBridgeModelName ( AsciiString name)
inline

Definition at line 115 of file TerrainRoads.h.

◆ friend_setBridgeModelNameBroken()

void TerrainRoadType::friend_setBridgeModelNameBroken ( AsciiString name)
inline

Definition at line 118 of file TerrainRoads.h.

◆ friend_setBridgeModelNameDamaged()

void TerrainRoadType::friend_setBridgeModelNameDamaged ( AsciiString name)
inline

Definition at line 116 of file TerrainRoads.h.

◆ friend_setBridgeModelNameReallyDamaged()

void TerrainRoadType::friend_setBridgeModelNameReallyDamaged ( AsciiString name)
inline

Definition at line 117 of file TerrainRoads.h.

◆ friend_setBridgeScale()

void TerrainRoadType::friend_setBridgeScale ( Real scale)
inline

Definition at line 112 of file TerrainRoads.h.

◆ friend_setDamageToFXString()

void TerrainRoadType::friend_setDamageToFXString ( BodyDamageType state,
Int index,
AsciiString s )
inline

Definition at line 125 of file TerrainRoads.h.

◆ friend_setDamageToOCLString()

void TerrainRoadType::friend_setDamageToOCLString ( BodyDamageType state,
Int index,
AsciiString s )
inline

Definition at line 124 of file TerrainRoads.h.

◆ friend_setDamageToSoundString()

void TerrainRoadType::friend_setDamageToSoundString ( BodyDamageType state,
AsciiString s )
inline

Definition at line 123 of file TerrainRoads.h.

◆ friend_setID()

void TerrainRoadType::friend_setID ( UnsignedInt id)
inline

Definition at line 107 of file TerrainRoads.h.

◆ friend_setName()

void TerrainRoadType::friend_setName ( AsciiString name)
inline

Definition at line 104 of file TerrainRoads.h.

◆ friend_setNext()

void TerrainRoadType::friend_setNext ( TerrainRoadType * next)
inline

Definition at line 108 of file TerrainRoads.h.

◆ friend_setNumFXPerType()

void TerrainRoadType::friend_setNumFXPerType ( Int num)
inline

Definition at line 130 of file TerrainRoads.h.

◆ friend_setRepairedToFXString()

void TerrainRoadType::friend_setRepairedToFXString ( BodyDamageType state,
Int index,
AsciiString s )
inline

Definition at line 128 of file TerrainRoads.h.

◆ friend_setRepairedToOCLString()

void TerrainRoadType::friend_setRepairedToOCLString ( BodyDamageType state,
Int index,
AsciiString s )
inline

Definition at line 127 of file TerrainRoads.h.

◆ friend_setRepairedToSoundString()

void TerrainRoadType::friend_setRepairedToSoundString ( BodyDamageType state,
AsciiString s )
inline

Definition at line 126 of file TerrainRoads.h.

◆ friend_setRoadWidth()

void TerrainRoadType::friend_setRoadWidth ( Real width)
inline

Definition at line 110 of file TerrainRoads.h.

◆ friend_setRoadWidthInTexture()

void TerrainRoadType::friend_setRoadWidthInTexture ( Real width)
inline

Definition at line 111 of file TerrainRoads.h.

◆ friend_setScaffoldObjectName()

void TerrainRoadType::friend_setScaffoldObjectName ( AsciiString name)
inline

Definition at line 113 of file TerrainRoads.h.

◆ friend_setScaffoldSupportObjectName()

void TerrainRoadType::friend_setScaffoldSupportObjectName ( AsciiString name)
inline

Definition at line 114 of file TerrainRoads.h.

◆ friend_setTexture()

void TerrainRoadType::friend_setTexture ( AsciiString texture)
inline

Definition at line 105 of file TerrainRoads.h.

◆ friend_setTextureBroken()

void TerrainRoadType::friend_setTextureBroken ( AsciiString texture)
inline

Definition at line 121 of file TerrainRoads.h.

◆ friend_setTextureDamaged()

void TerrainRoadType::friend_setTextureDamaged ( AsciiString texture)
inline

Definition at line 119 of file TerrainRoads.h.

◆ friend_setTextureReallyDamaged()

void TerrainRoadType::friend_setTextureReallyDamaged ( AsciiString texture)
inline

Definition at line 120 of file TerrainRoads.h.

◆ friend_setTowerObjectName()

void TerrainRoadType::friend_setTowerObjectName ( BridgeTowerType tower,
AsciiString name )
inline

Definition at line 122 of file TerrainRoads.h.

◆ friend_setTransitionEffectsHeight()

void TerrainRoadType::friend_setTransitionEffectsHeight ( Real height)
inline

Definition at line 129 of file TerrainRoads.h.

◆ getBridgeFieldParse()

const FieldParse * TerrainRoadType::getBridgeFieldParse ( void )
inline

Definition at line 134 of file TerrainRoads.h.

◆ getBridgeModel()

AsciiString TerrainRoadType::getBridgeModel ( void )
inline

Definition at line 86 of file TerrainRoads.h.

◆ getBridgeModelNameBroken()

AsciiString TerrainRoadType::getBridgeModelNameBroken ( void )
inline

Definition at line 89 of file TerrainRoads.h.

◆ getBridgeModelNameDamaged()

AsciiString TerrainRoadType::getBridgeModelNameDamaged ( void )
inline

Definition at line 87 of file TerrainRoads.h.

◆ getBridgeModelNameReallyDamaged()

AsciiString TerrainRoadType::getBridgeModelNameReallyDamaged ( void )
inline

Definition at line 88 of file TerrainRoads.h.

◆ getBridgeScale()

Real TerrainRoadType::getBridgeScale ( void )
inline

Definition at line 82 of file TerrainRoads.h.

◆ getDamageToFXString()

AsciiString TerrainRoadType::getDamageToFXString ( BodyDamageType state,
Int index )
inline

Definition at line 96 of file TerrainRoads.h.

◆ getDamageToOCLString()

AsciiString TerrainRoadType::getDamageToOCLString ( BodyDamageType state,
Int index )
inline

Definition at line 95 of file TerrainRoads.h.

◆ getDamageToSoundString()

AsciiString TerrainRoadType::getDamageToSoundString ( BodyDamageType state)
inline

Definition at line 94 of file TerrainRoads.h.

◆ getID()

UnsignedInt TerrainRoadType::getID ( void )
inline

Definition at line 77 of file TerrainRoads.h.

◆ getName()

AsciiString TerrainRoadType::getName ( void )
inline

Definition at line 74 of file TerrainRoads.h.

◆ getNumFXPerType()

Int TerrainRoadType::getNumFXPerType ( void )
inline

Definition at line 101 of file TerrainRoads.h.

◆ getRadarColor()

RGBColor TerrainRoadType::getRadarColor ( void )
inline

Definition at line 85 of file TerrainRoads.h.

◆ getRepairedToFXString()

AsciiString TerrainRoadType::getRepairedToFXString ( BodyDamageType state,
Int index )
inline

Definition at line 99 of file TerrainRoads.h.

◆ getRepairedToOCLString()

AsciiString TerrainRoadType::getRepairedToOCLString ( BodyDamageType state,
Int index )
inline

Definition at line 98 of file TerrainRoads.h.

◆ getRepairedToSoundString()

AsciiString TerrainRoadType::getRepairedToSoundString ( BodyDamageType state)
inline

Definition at line 97 of file TerrainRoads.h.

◆ getRoadFieldParse()

const FieldParse * TerrainRoadType::getRoadFieldParse ( void )
inline

get the parsing table for INI

Definition at line 133 of file TerrainRoads.h.

◆ getRoadWidth()

Real TerrainRoadType::getRoadWidth ( void )
inline

Definition at line 79 of file TerrainRoads.h.

◆ getRoadWidthInTexture()

Real TerrainRoadType::getRoadWidthInTexture ( void )
inline

Definition at line 80 of file TerrainRoads.h.

◆ getScaffoldObjectName()

AsciiString TerrainRoadType::getScaffoldObjectName ( void )
inline

Definition at line 83 of file TerrainRoads.h.

◆ getScaffoldSupportObjectName()

AsciiString TerrainRoadType::getScaffoldSupportObjectName ( void )
inline

Definition at line 84 of file TerrainRoads.h.

◆ getTexture()

AsciiString TerrainRoadType::getTexture ( void )
inline

Definition at line 75 of file TerrainRoads.h.

◆ getTextureBroken()

AsciiString TerrainRoadType::getTextureBroken ( void )
inline

Definition at line 92 of file TerrainRoads.h.

◆ getTextureDamaged()

AsciiString TerrainRoadType::getTextureDamaged ( void )
inline

Definition at line 90 of file TerrainRoads.h.

◆ getTextureReallyDamaged()

AsciiString TerrainRoadType::getTextureReallyDamaged ( void )
inline

Definition at line 91 of file TerrainRoads.h.

◆ getTowerObjectName()

AsciiString TerrainRoadType::getTowerObjectName ( BridgeTowerType tower)
inline

Definition at line 93 of file TerrainRoads.h.

◆ getTransitionEffectsHeight()

Real TerrainRoadType::getTransitionEffectsHeight ( void )
inline

Definition at line 100 of file TerrainRoads.h.

◆ isBridge()

Bool TerrainRoadType::isBridge ( void )
inline

Definition at line 76 of file TerrainRoads.h.

◆ parseTransitionToFX()

void TerrainRoadType::parseTransitionToFX ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

In the form of Label = Transition:<Damage|Repair> ToState:<BODYTYPE> EffectNum:<INT> FX:<FXLIST NAME>

Definition at line 153 of file TerrainRoads.cpp.

◆ parseTransitionToOCL()

void TerrainRoadType::parseTransitionToOCL ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

In the form of Label = Transition:<Damage|Repair> ToState:<BODYTYPE> EffectNum:<INT> OCL:<OCL NAME>

Definition at line 97 of file TerrainRoads.cpp.

Member Data Documentation

◆ m_bridgeModelName

AsciiString TerrainRoadType::m_bridgeModelName
protected

model name for bridge

Definition at line 166 of file TerrainRoads.h.

◆ m_bridgeModelNameBroken

AsciiString TerrainRoadType::m_bridgeModelNameBroken
protected

model name for bridge

Definition at line 175 of file TerrainRoads.h.

◆ m_bridgeModelNameDamaged

AsciiString TerrainRoadType::m_bridgeModelNameDamaged
protected

model name for bridge

Definition at line 169 of file TerrainRoads.h.

◆ m_bridgeModelNameReallyDamaged

AsciiString TerrainRoadType::m_bridgeModelNameReallyDamaged
protected

model name for bridge

Definition at line 172 of file TerrainRoads.h.

◆ m_bridgeScale

Real TerrainRoadType::m_bridgeScale
protected

scale for bridge

Definition at line 159 of file TerrainRoads.h.

◆ m_damageToFXString

AsciiString TerrainRoadType::m_damageToFXString[BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
protected

Definition at line 186 of file TerrainRoads.h.

◆ m_damageToOCLString

AsciiString TerrainRoadType::m_damageToOCLString[BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
protected

Definition at line 185 of file TerrainRoads.h.

◆ m_damageToSoundString

AsciiString TerrainRoadType::m_damageToSoundString[BODYDAMAGETYPE_COUNT]
protected

Definition at line 184 of file TerrainRoads.h.

◆ m_id

UnsignedInt TerrainRoadType::m_id
protected

unique id

Definition at line 140 of file TerrainRoads.h.

◆ m_isBridge

Bool TerrainRoadType::m_isBridge
protected

true if entry is for a bridge

Definition at line 139 of file TerrainRoads.h.

◆ m_name

AsciiString TerrainRoadType::m_name
protected

entry name

Definition at line 138 of file TerrainRoads.h.

◆ m_next

TerrainRoadType* TerrainRoadType::m_next
protected

next in road list

Definition at line 141 of file TerrainRoads.h.

◆ m_numFXPerType

Int TerrainRoadType::m_numFXPerType
protected

for each fx/ocl we will make this many of them on the bridge area

Definition at line 191 of file TerrainRoads.h.

◆ m_radarColor

RGBColor TerrainRoadType::m_radarColor
protected

color for this bridge on the radar

Definition at line 164 of file TerrainRoads.h.

◆ m_repairedToFXString

AsciiString TerrainRoadType::m_repairedToFXString[BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
protected

Definition at line 189 of file TerrainRoads.h.

◆ m_repairedToOCLString

AsciiString TerrainRoadType::m_repairedToOCLString[BODYDAMAGETYPE_COUNT][MAX_BRIDGE_BODY_FX]
protected

Definition at line 188 of file TerrainRoads.h.

◆ m_repairedToSoundString

AsciiString TerrainRoadType::m_repairedToSoundString[BODYDAMAGETYPE_COUNT]
protected

Definition at line 187 of file TerrainRoads.h.

◆ m_roadWidth

Real TerrainRoadType::m_roadWidth
protected

width of road

Definition at line 155 of file TerrainRoads.h.

◆ m_roadWidthInTexture

Real TerrainRoadType::m_roadWidthInTexture
protected

width of road in the texture

Definition at line 156 of file TerrainRoads.h.

◆ m_scaffoldObjectName

AsciiString TerrainRoadType::m_scaffoldObjectName
protected

scaffold object name

Definition at line 161 of file TerrainRoads.h.

◆ m_scaffoldSupportObjectName

AsciiString TerrainRoadType::m_scaffoldSupportObjectName
protected

scaffold support object name

Definition at line 162 of file TerrainRoads.h.

◆ m_terrainBridgeFieldParseTable

const FieldParse TerrainRoadType::m_terrainBridgeFieldParseTable
staticprotected

the parse table for INI definition

Definition at line 58 of file TerrainRoads.h.

◆ m_terrainRoadFieldParseTable

const FieldParse TerrainRoadType::m_terrainRoadFieldParseTable
staticprotected
Initial value:
=
{
{ "Texture", INI::parseAsciiString, NULL, offsetof( TerrainRoadType, m_texture ) },
{ "RoadWidth", INI::parseReal, NULL, offsetof( TerrainRoadType, m_roadWidth ) },
{ "RoadWidthInTexture", INI::parseReal, NULL, offsetof( TerrainRoadType, m_roadWidthInTexture ) },
{ NULL, NULL, NULL, 0 },
}
#define NULL
Definition BaseType.h:92
static void parseAsciiString(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:653
static void parseReal(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:558
AsciiString m_texture
texture filename
Real m_roadWidthInTexture
width of road in the texture
Real m_roadWidth
width of road

the parse table for INI definition

Definition at line 45 of file TerrainRoads.h.

◆ m_texture

AsciiString TerrainRoadType::m_texture
protected

texture filename

Definition at line 167 of file TerrainRoads.h.

◆ m_textureBroken

AsciiString TerrainRoadType::m_textureBroken
protected

model name for bridge

Definition at line 176 of file TerrainRoads.h.

◆ m_textureDamaged

AsciiString TerrainRoadType::m_textureDamaged
protected

model name for bridge

Definition at line 170 of file TerrainRoads.h.

◆ m_textureReallyDamaged

AsciiString TerrainRoadType::m_textureReallyDamaged
protected

model name for bridge

Definition at line 173 of file TerrainRoads.h.

◆ m_towerObjectName

AsciiString TerrainRoadType::m_towerObjectName[BRIDGE_MAX_TOWERS]
protected

object names for the targetable towers on the bridge

Definition at line 178 of file TerrainRoads.h.

◆ m_transitionEffectsHeight

Real TerrainRoadType::m_transitionEffectsHeight
protected

Definition at line 190 of file TerrainRoads.h.


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