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 | Static Protected Member Functions | List of all members
ThingTemplate Class Reference

#include <ThingTemplate.h>

Inherits Overridable.

Public Member Functions

 ThingTemplate ()
 
void copyFrom (const ThingTemplate *that)
 
void resolveNames ()
 called by ThingFactory after all templates have been loaded.
 
UnsignedShort getTemplateID () const
 
const AsciiString & getName () const
 return the name of this template
 
Color getDisplayColor () const
 get the display color (used for the editor)
 
EditorSortingType getEditorSorting () const
 get the editor sorting
 
Bool isKindOf (KindOfType t) const
 return true iff the template has the specified kindOf flag set.
 
Bool isKindOfMulti (const KindOfMaskType &mustBeSet, const KindOfMaskType &mustBeClear) const
 convenience for doing multiple kindof testing at once.
 
Bool isAnyKindOf (const KindOfMaskType &anyKindOf) const
 
const UnicodeString & getDisplayName () const
 set the display name
 
RadarPriorityType getDefaultRadarPriority () const
 return radar priority from INI
 
Int getRawTransportSlotCount () const
 
Real getFenceWidth () const
 
Real getFenceXOffset () const
 
Bool isBridge () const
 
Real friend_calcVisionRange () const
 get vision range
 
Real friend_calcShroudClearingRange () const
 get vision range for Shroud ONLY (Design requested split)
 
Real getShroudRevealToAllRange () const
 
AIUpdateModuleData * friend_getAIModuleInfo (void)
 
ShadowType getShadowType () const
 
Real getShadowSizeX () const
 
Real getShadowSizeY () const
 
Real getShadowOffsetX () const
 
Real getShadowOffsetY () const
 
const AsciiString & getShadowTextureName (void) const
 
UnsignedInt getOcclusionDelay (void) const
 
const ModuleInfo & getBehaviorModuleInfo () const
 
const ModuleInfo & getDrawModuleInfo () const
 
const ModuleInfo & getClientUpdateModuleInfo () const
 
const Image * getSelectedPortraitImage (void) const
 
const Image * getButtonImage (void) const
 
Int getSkillPointValue (Int level) const
 
Int getExperienceValue (Int level) const
 
Int getExperienceRequired (Int level) const
 
Bool isTrainable () const
 
Bool isEnterGuard () const
 
Bool isHijackGuard () const
 
const AudioEventRTS * getVoiceSelect () const
 
const AudioEventRTS * getVoiceGroupSelect () const
 
const AudioEventRTS * getVoiceMove () const
 
const AudioEventRTS * getVoiceAttack () const
 
const AudioEventRTS * getVoiceEnter () const
 
const AudioEventRTS * getVoiceFear () const
 
const AudioEventRTS * getVoiceSelectElite () const
 
const AudioEventRTS * getVoiceCreated () const
 
const AudioEventRTS * getVoiceNearEnemy () const
 
const AudioEventRTS * getVoiceTaskUnable () const
 
const AudioEventRTS * getVoiceTaskComplete () const
 
const AudioEventRTS * getVoiceMeetEnemy () const
 
const AudioEventRTS * getVoiceGarrison () const
 
const AudioEventRTS * getVoiceDefect () const
 
const AudioEventRTS * getVoiceAttackSpecial () const
 
const AudioEventRTS * getVoiceAttackAir () const
 
const AudioEventRTS * getVoiceGuard () const
 
const AudioEventRTS * getSoundMoveStart () const
 
const AudioEventRTS * getSoundMoveStartDamaged () const
 
const AudioEventRTS * getSoundMoveLoop () const
 
const AudioEventRTS * getSoundMoveLoopDamaged () const
 
const AudioEventRTS * getSoundAmbient () const
 
const AudioEventRTS * getSoundAmbientDamaged () const
 
const AudioEventRTS * getSoundAmbientReallyDamaged () const
 
const AudioEventRTS * getSoundAmbientRubble () const
 
const AudioEventRTS * getSoundStealthOn () const
 
const AudioEventRTS * getSoundStealthOff () const
 
const AudioEventRTS * getSoundCreated () const
 
const AudioEventRTS * getSoundOnDamaged () const
 
const AudioEventRTS * getSoundOnReallyDamaged () const
 
const AudioEventRTS * getSoundEnter () const
 
const AudioEventRTS * getSoundExit () const
 
const AudioEventRTS * getSoundPromotedVeteran () const
 
const AudioEventRTS * getSoundPromotedElite () const
 
const AudioEventRTS * getSoundPromotedHero () const
 
const AudioEventRTS * getSoundFalling () const
 
Bool hasSoundAmbient () const
 
const AudioEventRTS * getPerUnitSound (const AsciiString &soundName) const
 
const FXList * getPerUnitFX (const AsciiString &fxName) const
 
UnsignedInt getThreatValue () const
 
NameKeyType getMaxSimultaneousLinkKey () const
 
UnsignedInt getMaxSimultaneousOfType () const
 
void validate ()
 
const AsciiString & friend_getCommandSetString () const
 
const std::vector< AsciiString > & getBuildVariations () const
 
Real getAssetScale () const
 return uniform scaling
 
Real getInstanceScaleFuzziness () const
 return uniform scaling
 
Real getStructureRubbleHeight () const
 return uniform scaling
 
const GeometryInfo & getTemplateGeometryInfo () const
 
void friend_setTemplateName (const AsciiString &name)
 
ThingTemplate * friend_getNextTemplate () const
 
void friend_setNextTemplate (ThingTemplate *tmplate)
 
void friend_setTemplateID (UnsignedShort id)
 
Int getEnergyProduction () const
 
Int getEnergyBonus () const
 
Int getRefundValue () const
 
BuildCompletionType getBuildCompletion () const
 
BuildableStatus getBuildable () const
 
Int getPrereqCount () const
 
const ProductionPrerequisite * getNthPrereq (Int i) const
 
const ThingTemplate * getBuildFacilityTemplate (const Player *player) const
 
Bool isBuildableItem (void) const
 
Int calcTimeToBuild (const Player *player) const
 calculate how long (in logic frames) it will take the given player to build this unit
 
Int calcCostToBuild (const Player *player) const
 calculate how much money it will take the given player to build this unit
 
Int friend_getBuildCost () const
 Used only by Skirmish AI. Everyone else should call calcCostToBuild.
 
const AsciiString & getDefaultOwningSide () const
 
const FieldParse * getFieldParse () const
 get us the table to parse the fields for thing templates
 
const FieldParse * getReskinFieldParse () const
 
Bool isBuildFacility () const
 
Real getPlacementViewAngle (void) const
 
Real getFactoryExitWidth () const
 
Real getFactoryExtraBibWidth () const
 
void setCopiedFromDefault ()
 
void setReskinnedFrom (const ThingTemplate *tt)
 
Bool isPrerequisite () const
 
const WeaponTemplateSet * findWeaponTemplateSet (const WeaponSetFlags &t) const
 
const ArmorTemplateSet * findArmorTemplateSet (const ArmorSetFlags &t) const
 
Bool canPossiblyHaveAnyWeapon () const
 
Bool isEquivalentTo (const ThingTemplate *tt) const
 
UnsignedByte getCrushableLevel () const
 
UnsignedByte getCrusherLevel () const
 
AsciiString getUpgradeCameoName (Int n) const
 
const WeaponTemplateSetVector & getWeaponTemplateSets (void) const
 
- Public Member Functions inherited from Overridable
 Overridable ()
 
const Overridable * getNextOverride (void) const
 
const Overridable * getFinalOverride (void) const
 
void setNextOverride (Overridable *nextOverridable)
 
Overridable * friend_getNextOverride (void)
 
Overridable * friend_getFinalOverride (void)
 
const Overridable * friend_getFinalOverride (void) const
 
void markAsOverride (void)
 
Overridable * deleteOverrides (void)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Protected Member Functions

Int getBuildCost () const
 
Real getBuildTime () const
 
const PerUnitSoundMap * getAllPerUnitSounds (void) const
 
void validateAudio ()
 
const AudioEventRTS * getAudio (ThingTemplateAudioType t) const
 
Bool hasAudio (ThingTemplateAudioType t) const
 
Bool removeModuleInfo (const AsciiString &moduleToRemove, AsciiString &clearedModuleNameOut)
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Static Protected Member Functions

static void parseArmorTemplateSet (INI *ini, void *instance, void *store, const void *)
 
static void parseWeaponTemplateSet (INI *ini, void *instance, void *store, const void *)
 
static void parsePrerequisites (INI *ini, void *instance, void *, const void *)
 
static void parseModuleName (INI *ini, void *instance, void *, const void *userData)
 
static void parseIntList (INI *ini, void *instance, void *store, const void *userData)
 
static void parsePerUnitSounds (INI *ini, void *instance, void *store, const void *userData)
 
static void parsePerUnitFX (INI *ini, void *instance, void *store, const void *userData)
 
static void parseAddModule (INI *ini, void *instance, void *store, const void *userData)
 
static void parseRemoveModule (INI *ini, void *instance, void *store, const void *userData)
 
static void parseReplaceModule (INI *ini, void *instance, void *store, const void *userData)
 
static void parseInheritableModule (INI *ini, void *instance, void *store, const void *userData)
 
static void OverrideableByLikeKind (INI *ini, void *instance, void *store, const void *userData)
 
static void parseMaxSimultaneous (INI *ini, void *instance, void *store, const void *userData)
 

Detailed Description

Definition of a thing template to read from our game data framework

Definition at line 348 of file ThingTemplate.h.

Constructor & Destructor Documentation

◆ ThingTemplate()

ThingTemplate::ThingTemplate ( )

Definition at line 989 of file ThingTemplate.cpp.

Member Function Documentation

◆ calcCostToBuild()

Int ThingTemplate::calcCostToBuild ( const Player * player) const

calculate how much money it will take the given player to build this unit

NOTE that we're not paying attention to m_override here, instead the portions that retrieve template data values use the get() wrappers, which DO pay attention to the override values

Definition at line 1532 of file ThingTemplate.cpp.

◆ calcTimeToBuild()

Int ThingTemplate::calcTimeToBuild ( const Player * player) const

calculate how long (in logic frames) it will take the given player to build this unit

NOTE that we're not paying attention to m_override here, instead the portions that retrieve template data values use the get() wrappers, which DO pay attention to the override values

Definition at line 1548 of file ThingTemplate.cpp.

◆ canPossiblyHaveAnyWeapon()

Bool ThingTemplate::canPossiblyHaveAnyWeapon ( ) const

Definition at line 1379 of file ThingTemplate.cpp.

◆ copyFrom()

void ThingTemplate::copyFrom ( const ThingTemplate * that)

Definition at line 1219 of file ThingTemplate.cpp.

◆ findArmorTemplateSet()

const ArmorTemplateSet * ThingTemplate::findArmorTemplateSet ( const ArmorSetFlags & t) const

Definition at line 1365 of file ThingTemplate.cpp.

◆ findWeaponTemplateSet()

const WeaponTemplateSet * ThingTemplate::findWeaponTemplateSet ( const WeaponSetFlags & t) const

Definition at line 1371 of file ThingTemplate.cpp.

◆ friend_calcShroudClearingRange()

Real ThingTemplate::friend_calcShroudClearingRange ( ) const
inline

get vision range for Shroud ONLY (Design requested split)

Definition at line 430 of file ThingTemplate.h.

◆ friend_calcVisionRange()

Real ThingTemplate::friend_calcVisionRange ( ) const
inline

get vision range

Definition at line 429 of file ThingTemplate.h.

◆ friend_getAIModuleInfo()

AIUpdateModuleData * ThingTemplate::friend_getAIModuleInfo ( void )

Definition at line 1053 of file ThingTemplate.cpp.

◆ friend_getBuildCost()

Int ThingTemplate::friend_getBuildCost ( ) const
inline

Used only by Skirmish AI. Everyone else should call calcCostToBuild.

Definition at line 586 of file ThingTemplate.h.

◆ friend_getCommandSetString()

const AsciiString & ThingTemplate::friend_getCommandSetString ( ) const
inline

Definition at line 525 of file ThingTemplate.h.

◆ friend_getNextTemplate()

ThingTemplate * ThingTemplate::friend_getNextTemplate ( ) const
inline

Definition at line 545 of file ThingTemplate.h.

◆ friend_setNextTemplate()

void ThingTemplate::friend_setNextTemplate ( ThingTemplate * tmplate)
inline

Definition at line 546 of file ThingTemplate.h.

◆ friend_setTemplateID()

void ThingTemplate::friend_setTemplateID ( UnsignedShort id)
inline

Definition at line 547 of file ThingTemplate.h.

◆ friend_setTemplateName()

void ThingTemplate::friend_setTemplateName ( const AsciiString & name)
inline

Definition at line 544 of file ThingTemplate.h.

◆ getAllPerUnitSounds()

const PerUnitSoundMap * ThingTemplate::getAllPerUnitSounds ( void ) const
inlineprotected

Definition at line 630 of file ThingTemplate.h.

◆ getAssetScale()

Real ThingTemplate::getAssetScale ( ) const
inline

return uniform scaling

Definition at line 529 of file ThingTemplate.h.

◆ getAudio()

const AudioEventRTS * ThingTemplate::getAudio ( ThingTemplateAudioType t) const
inlineprotected

Definition at line 632 of file ThingTemplate.h.

◆ getBehaviorModuleInfo()

const ModuleInfo & ThingTemplate::getBehaviorModuleInfo ( ) const
inline

Definition at line 447 of file ThingTemplate.h.

◆ getBuildable()

BuildableStatus ThingTemplate::getBuildable ( ) const

Definition at line 1416 of file ThingTemplate.cpp.

◆ getBuildCompletion()

BuildCompletionType ThingTemplate::getBuildCompletion ( ) const
inline

Definition at line 558 of file ThingTemplate.h.

◆ getBuildCost()

Int ThingTemplate::getBuildCost ( ) const
inlineprotected

Definition at line 628 of file ThingTemplate.h.

◆ getBuildFacilityTemplate()

const ThingTemplate * ThingTemplate::getBuildFacilityTemplate ( const Player * player) const

return the BuildFacilityTemplate, if any.

if this template needs no build facility, null is returned.

if the template needs a build facility but the given player doesn't have any in existence, null will be returned.

if you pass null for player, we'll return the 'natural' build facility.

Definition at line 1403 of file ThingTemplate.cpp.

◆ getBuildTime()

Real ThingTemplate::getBuildTime ( ) const
inlineprotected

Definition at line 629 of file ThingTemplate.h.

◆ getBuildVariations()

const std::vector< AsciiString > & ThingTemplate::getBuildVariations ( ) const
inline

Definition at line 527 of file ThingTemplate.h.

◆ getButtonImage()

const Image * ThingTemplate::getButtonImage ( void ) const
inline

Definition at line 452 of file ThingTemplate.h.

◆ getClientUpdateModuleInfo()

const ModuleInfo & ThingTemplate::getClientUpdateModuleInfo ( ) const
inline

Definition at line 449 of file ThingTemplate.h.

◆ getCrushableLevel()

UnsignedByte ThingTemplate::getCrushableLevel ( ) const
inline

Definition at line 615 of file ThingTemplate.h.

◆ getCrusherLevel()

UnsignedByte ThingTemplate::getCrusherLevel ( ) const
inline

Definition at line 616 of file ThingTemplate.h.

◆ getDefaultOwningSide()

const AsciiString & ThingTemplate::getDefaultOwningSide ( ) const
inline

Definition at line 588 of file ThingTemplate.h.

◆ getDefaultRadarPriority()

RadarPriorityType ThingTemplate::getDefaultRadarPriority ( ) const
inline

return radar priority from INI

Definition at line 417 of file ThingTemplate.h.

◆ getDisplayColor()

Color ThingTemplate::getDisplayColor ( ) const
inline

get the display color (used for the editor)

Definition at line 392 of file ThingTemplate.h.

◆ getDisplayName()

const UnicodeString & ThingTemplate::getDisplayName ( ) const
inline

set the display name

return display name

Definition at line 415 of file ThingTemplate.h.

◆ getDrawModuleInfo()

const ModuleInfo & ThingTemplate::getDrawModuleInfo ( ) const
inline

Definition at line 448 of file ThingTemplate.h.

◆ getEditorSorting()

EditorSortingType ThingTemplate::getEditorSorting ( ) const
inline

get the editor sorting

Definition at line 395 of file ThingTemplate.h.

◆ getEnergyBonus()

Int ThingTemplate::getEnergyBonus ( ) const
inline

Definition at line 550 of file ThingTemplate.h.

◆ getEnergyProduction()

Int ThingTemplate::getEnergyProduction ( ) const
inline

Definition at line 549 of file ThingTemplate.h.

◆ getExperienceRequired()

Int ThingTemplate::getExperienceRequired ( Int level) const
inline

Definition at line 460 of file ThingTemplate.h.

◆ getExperienceValue()

Int ThingTemplate::getExperienceValue ( Int level) const
inline

Definition at line 459 of file ThingTemplate.h.

◆ getFactoryExitWidth()

Real ThingTemplate::getFactoryExitWidth ( ) const
inline

Definition at line 597 of file ThingTemplate.h.

◆ getFactoryExtraBibWidth()

Real ThingTemplate::getFactoryExtraBibWidth ( ) const
inline

Definition at line 598 of file ThingTemplate.h.

◆ getFenceWidth()

Real ThingTemplate::getFenceWidth ( ) const
inline

Definition at line 422 of file ThingTemplate.h.

◆ getFenceXOffset()

Real ThingTemplate::getFenceXOffset ( ) const
inline

Definition at line 424 of file ThingTemplate.h.

◆ getFieldParse()

const FieldParse * ThingTemplate::getFieldParse ( ) const
inline

get us the table to parse the fields for thing templates

Definition at line 591 of file ThingTemplate.h.

◆ getInstanceScaleFuzziness()

Real ThingTemplate::getInstanceScaleFuzziness ( ) const
inline

return uniform scaling

Definition at line 530 of file ThingTemplate.h.

◆ getMaxSimultaneousLinkKey()

NameKeyType ThingTemplate::getMaxSimultaneousLinkKey ( ) const
inline

If this is not NAMEKEY_INVALID, it indicates that all the templates which return the same name key should be counted as the same "type" when looking at getMaxSimultaneousOfType(). For instance, a Scud Storm and a Scud Storm rebuild hole will return the same value, so that the player can't build another Scud Storm while waiting for the rebuild hole to start rebuilding

Definition at line 518 of file ThingTemplate.h.

◆ getMaxSimultaneousOfType()

UnsignedInt ThingTemplate::getMaxSimultaneousOfType ( ) const

Definition at line 1464 of file ThingTemplate.cpp.

◆ getName()

const AsciiString & ThingTemplate::getName ( ) const
inline

return the name of this template

Definition at line 389 of file ThingTemplate.h.

◆ getNthPrereq()

const ProductionPrerequisite * ThingTemplate::getNthPrereq ( Int i) const
inline

Definition at line 563 of file ThingTemplate.h.

◆ getOcclusionDelay()

UnsignedInt ThingTemplate::getOcclusionDelay ( void ) const
inline

Definition at line 445 of file ThingTemplate.h.

◆ getPerUnitFX()

const FXList * ThingTemplate::getPerUnitFX ( const AsciiString & fxName) const

Definition at line 1426 of file ThingTemplate.cpp.

◆ getPerUnitSound()

const AudioEventRTS * ThingTemplate::getPerUnitSound ( const AsciiString & soundName) const

Definition at line 1444 of file ThingTemplate.cpp.

◆ getPlacementViewAngle()

Real ThingTemplate::getPlacementViewAngle ( void ) const
inline

Definition at line 595 of file ThingTemplate.h.

◆ getPrereqCount()

Int ThingTemplate::getPrereqCount ( ) const
inline

Definition at line 562 of file ThingTemplate.h.

◆ getRawTransportSlotCount()

Int ThingTemplate::getRawTransportSlotCount ( ) const
inline

Definition at line 420 of file ThingTemplate.h.

◆ getRefundValue()

Int ThingTemplate::getRefundValue ( ) const
inline

Definition at line 556 of file ThingTemplate.h.

◆ getReskinFieldParse()

const FieldParse * ThingTemplate::getReskinFieldParse ( ) const
inline

Definition at line 592 of file ThingTemplate.h.

◆ getSelectedPortraitImage()

const Image * ThingTemplate::getSelectedPortraitImage ( void ) const
inline

Definition at line 451 of file ThingTemplate.h.

◆ getShadowOffsetX()

Real ThingTemplate::getShadowOffsetX ( ) const
inline

Definition at line 441 of file ThingTemplate.h.

◆ getShadowOffsetY()

Real ThingTemplate::getShadowOffsetY ( ) const
inline

Definition at line 442 of file ThingTemplate.h.

◆ getShadowSizeX()

Real ThingTemplate::getShadowSizeX ( ) const
inline

Definition at line 439 of file ThingTemplate.h.

◆ getShadowSizeY()

Real ThingTemplate::getShadowSizeY ( ) const
inline

Definition at line 440 of file ThingTemplate.h.

◆ getShadowTextureName()

const AsciiString & ThingTemplate::getShadowTextureName ( void ) const
inline

Definition at line 444 of file ThingTemplate.h.

◆ getShadowType()

ShadowType ThingTemplate::getShadowType ( ) const
inline

Definition at line 438 of file ThingTemplate.h.

◆ getShroudRevealToAllRange()

Real ThingTemplate::getShroudRevealToAllRange ( ) const
inline

Definition at line 433 of file ThingTemplate.h.

◆ getSkillPointValue()

Int ThingTemplate::getSkillPointValue ( Int level) const

Definition at line 1392 of file ThingTemplate.cpp.

◆ getSoundAmbient()

const AudioEventRTS * ThingTemplate::getSoundAmbient ( ) const
inline

Definition at line 489 of file ThingTemplate.h.

◆ getSoundAmbientDamaged()

const AudioEventRTS * ThingTemplate::getSoundAmbientDamaged ( ) const
inline

Definition at line 490 of file ThingTemplate.h.

◆ getSoundAmbientReallyDamaged()

const AudioEventRTS * ThingTemplate::getSoundAmbientReallyDamaged ( ) const
inline

Definition at line 491 of file ThingTemplate.h.

◆ getSoundAmbientRubble()

const AudioEventRTS * ThingTemplate::getSoundAmbientRubble ( ) const
inline

Definition at line 492 of file ThingTemplate.h.

◆ getSoundCreated()

const AudioEventRTS * ThingTemplate::getSoundCreated ( ) const
inline

Definition at line 495 of file ThingTemplate.h.

◆ getSoundEnter()

const AudioEventRTS * ThingTemplate::getSoundEnter ( ) const
inline

Definition at line 498 of file ThingTemplate.h.

◆ getSoundExit()

const AudioEventRTS * ThingTemplate::getSoundExit ( ) const
inline

Definition at line 499 of file ThingTemplate.h.

◆ getSoundFalling()

const AudioEventRTS * ThingTemplate::getSoundFalling ( ) const
inline

Definition at line 503 of file ThingTemplate.h.

◆ getSoundMoveLoop()

const AudioEventRTS * ThingTemplate::getSoundMoveLoop ( ) const
inline

Definition at line 487 of file ThingTemplate.h.

◆ getSoundMoveLoopDamaged()

const AudioEventRTS * ThingTemplate::getSoundMoveLoopDamaged ( ) const
inline

Definition at line 488 of file ThingTemplate.h.

◆ getSoundMoveStart()

const AudioEventRTS * ThingTemplate::getSoundMoveStart ( ) const
inline

Definition at line 485 of file ThingTemplate.h.

◆ getSoundMoveStartDamaged()

const AudioEventRTS * ThingTemplate::getSoundMoveStartDamaged ( ) const
inline

Definition at line 486 of file ThingTemplate.h.

◆ getSoundOnDamaged()

const AudioEventRTS * ThingTemplate::getSoundOnDamaged ( ) const
inline

Definition at line 496 of file ThingTemplate.h.

◆ getSoundOnReallyDamaged()

const AudioEventRTS * ThingTemplate::getSoundOnReallyDamaged ( ) const
inline

Definition at line 497 of file ThingTemplate.h.

◆ getSoundPromotedElite()

const AudioEventRTS * ThingTemplate::getSoundPromotedElite ( ) const
inline

Definition at line 501 of file ThingTemplate.h.

◆ getSoundPromotedHero()

const AudioEventRTS * ThingTemplate::getSoundPromotedHero ( ) const
inline

Definition at line 502 of file ThingTemplate.h.

◆ getSoundPromotedVeteran()

const AudioEventRTS * ThingTemplate::getSoundPromotedVeteran ( ) const
inline

Definition at line 500 of file ThingTemplate.h.

◆ getSoundStealthOff()

const AudioEventRTS * ThingTemplate::getSoundStealthOff ( ) const
inline

Definition at line 494 of file ThingTemplate.h.

◆ getSoundStealthOn()

const AudioEventRTS * ThingTemplate::getSoundStealthOn ( ) const
inline

Definition at line 493 of file ThingTemplate.h.

◆ getStructureRubbleHeight()

Real ThingTemplate::getStructureRubbleHeight ( ) const
inline

return uniform scaling

Definition at line 531 of file ThingTemplate.h.

◆ getTemplateGeometryInfo()

const GeometryInfo & ThingTemplate::getTemplateGeometryInfo ( ) const
inline

Definition at line 538 of file ThingTemplate.h.

◆ getTemplateID()

UnsignedShort ThingTemplate::getTemplateID ( ) const
inline

return a unique identifier suitable for identifying this ThingTemplate on machines playing across the net. this should be considered a Magic Cookie and used only for net traffic or similar sorts of things. To convert an id back to a ThingTemplate, use ThingFactory::findByID(). Note that 0 is always an invalid id. NOTE that we are not referencing m_override here because even though we actually have multiple templates here representing overrides, we still only conceptually have one template and want to always use one single pointer for comparisons of templates. However, even if we did reference m_override the IDs would be the same for each one since every override first COPIES data from the current/parent template data.

Definition at line 386 of file ThingTemplate.h.

◆ getThreatValue()

UnsignedInt ThingTemplate::getThreatValue ( ) const
inline

Definition at line 510 of file ThingTemplate.h.

◆ getUpgradeCameoName()

AsciiString ThingTemplate::getUpgradeCameoName ( Int n) const
inline

Definition at line 618 of file ThingTemplate.h.

◆ getVoiceAttack()

const AudioEventRTS * ThingTemplate::getVoiceAttack ( ) const
inline

Definition at line 468 of file ThingTemplate.h.

◆ getVoiceAttackAir()

const AudioEventRTS * ThingTemplate::getVoiceAttackAir ( ) const
inline

Definition at line 483 of file ThingTemplate.h.

◆ getVoiceAttackSpecial()

const AudioEventRTS * ThingTemplate::getVoiceAttackSpecial ( ) const
inline

Definition at line 482 of file ThingTemplate.h.

◆ getVoiceCreated()

const AudioEventRTS * ThingTemplate::getVoiceCreated ( ) const
inline

Definition at line 472 of file ThingTemplate.h.

◆ getVoiceDefect()

const AudioEventRTS * ThingTemplate::getVoiceDefect ( ) const
inline

Definition at line 481 of file ThingTemplate.h.

◆ getVoiceEnter()

const AudioEventRTS * ThingTemplate::getVoiceEnter ( ) const
inline

Definition at line 469 of file ThingTemplate.h.

◆ getVoiceFear()

const AudioEventRTS * ThingTemplate::getVoiceFear ( ) const
inline

Definition at line 470 of file ThingTemplate.h.

◆ getVoiceGarrison()

const AudioEventRTS * ThingTemplate::getVoiceGarrison ( ) const
inline

Definition at line 477 of file ThingTemplate.h.

◆ getVoiceGroupSelect()

const AudioEventRTS * ThingTemplate::getVoiceGroupSelect ( ) const
inline

Definition at line 466 of file ThingTemplate.h.

◆ getVoiceGuard()

const AudioEventRTS * ThingTemplate::getVoiceGuard ( ) const
inline

Definition at line 484 of file ThingTemplate.h.

◆ getVoiceMeetEnemy()

const AudioEventRTS * ThingTemplate::getVoiceMeetEnemy ( ) const
inline

Definition at line 476 of file ThingTemplate.h.

◆ getVoiceMove()

const AudioEventRTS * ThingTemplate::getVoiceMove ( ) const
inline

Definition at line 467 of file ThingTemplate.h.

◆ getVoiceNearEnemy()

const AudioEventRTS * ThingTemplate::getVoiceNearEnemy ( ) const
inline

Definition at line 473 of file ThingTemplate.h.

◆ getVoiceSelect()

const AudioEventRTS * ThingTemplate::getVoiceSelect ( ) const
inline

Definition at line 465 of file ThingTemplate.h.

◆ getVoiceSelectElite()

const AudioEventRTS * ThingTemplate::getVoiceSelectElite ( ) const
inline

Definition at line 471 of file ThingTemplate.h.

◆ getVoiceTaskComplete()

const AudioEventRTS * ThingTemplate::getVoiceTaskComplete ( ) const
inline

Definition at line 475 of file ThingTemplate.h.

◆ getVoiceTaskUnable()

const AudioEventRTS * ThingTemplate::getVoiceTaskUnable ( ) const
inline

Definition at line 474 of file ThingTemplate.h.

◆ getWeaponTemplateSets()

const WeaponTemplateSetVector & ThingTemplate::getWeaponTemplateSets ( void ) const
inline

Definition at line 620 of file ThingTemplate.h.

◆ hasAudio()

Bool ThingTemplate::hasAudio ( ThingTemplateAudioType t) const
inlineprotected

Definition at line 633 of file ThingTemplate.h.

◆ hasSoundAmbient()

Bool ThingTemplate::hasSoundAmbient ( ) const
inline

Definition at line 505 of file ThingTemplate.h.

◆ isAnyKindOf()

Bool ThingTemplate::isAnyKindOf ( const KindOfMaskType & anyKindOf) const
inline

Definition at line 409 of file ThingTemplate.h.

◆ isBridge()

Bool ThingTemplate::isBridge ( ) const
inline

Definition at line 426 of file ThingTemplate.h.

◆ isBuildableItem()

Bool ThingTemplate::isBuildableItem ( void ) const

Definition at line 1522 of file ThingTemplate.cpp.

◆ isBuildFacility()

Bool ThingTemplate::isBuildFacility ( ) const
inline

Definition at line 594 of file ThingTemplate.h.

◆ isEnterGuard()

Bool ThingTemplate::isEnterGuard ( ) const
inline

Definition at line 462 of file ThingTemplate.h.

◆ isEquivalentTo()

Bool ThingTemplate::isEquivalentTo ( const ThingTemplate * tt) const

Definition at line 1478 of file ThingTemplate.cpp.

◆ isHijackGuard()

Bool ThingTemplate::isHijackGuard ( ) const
inline

Definition at line 463 of file ThingTemplate.h.

◆ isKindOf()

Bool ThingTemplate::isKindOf ( KindOfType t) const
inline

return true iff the template has the specified kindOf flag set.

Definition at line 398 of file ThingTemplate.h.

◆ isKindOfMulti()

Bool ThingTemplate::isKindOfMulti ( const KindOfMaskType & mustBeSet,
const KindOfMaskType & mustBeClear ) const
inline

convenience for doing multiple kindof testing at once.

Definition at line 404 of file ThingTemplate.h.

◆ isPrerequisite()

Bool ThingTemplate::isPrerequisite ( ) const
inline

Definition at line 604 of file ThingTemplate.h.

◆ isTrainable()

Bool ThingTemplate::isTrainable ( ) const
inline

Definition at line 461 of file ThingTemplate.h.

◆ OverrideableByLikeKind()

void ThingTemplate::OverrideableByLikeKind ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

mark the module(s) as being "VverrideableByLikeKind". default module will be replaced by any of the exact same class

Definition at line 834 of file ThingTemplate.cpp.

◆ parseAddModule()

void ThingTemplate::parseAddModule ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Parse modules to add to the existing set of modules.

Definition at line 739 of file ThingTemplate.cpp.

◆ parseArmorTemplateSet()

void ThingTemplate::parseArmorTemplateSet ( INI * ini,
void * instance,
void * store,
const void *  )
staticprotected

Table for parsing the object fields

Definition at line 900 of file ThingTemplate.cpp.

◆ parseInheritableModule()

void ThingTemplate::parseInheritableModule ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

mark the module(s) as being "Inheritable".

Definition at line 815 of file ThingTemplate.cpp.

◆ parseIntList()

void ThingTemplate::parseIntList ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Definition at line 619 of file ThingTemplate.cpp.

◆ parseMaxSimultaneous()

void ThingTemplate::parseMaxSimultaneous ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Definition at line 957 of file ThingTemplate.cpp.

◆ parseModuleName()

void ThingTemplate::parseModuleName ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Definition at line 510 of file ThingTemplate.cpp.

◆ parsePerUnitFX()

void ThingTemplate::parsePerUnitFX ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Definition at line 691 of file ThingTemplate.cpp.

◆ parsePerUnitSounds()

void ThingTemplate::parsePerUnitSounds ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Parse Additional per unit sounds such as TankTurretMove and TankTurretMoveLoop.

Definition at line 722 of file ThingTemplate.cpp.

◆ parsePrerequisites()

void ThingTemplate::parsePrerequisites ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Definition at line 659 of file ThingTemplate.cpp.

◆ parseRemoveModule()

void ThingTemplate::parseRemoveModule ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Parse modules to remove from the existing set of modules.

Definition at line 758 of file ThingTemplate.cpp.

◆ parseReplaceModule()

void ThingTemplate::parseReplaceModule ( INI * ini,
void * instance,
void * store,
const void * userData )
staticprotected

Replace the existing tagged modules with the new modules.

Definition at line 783 of file ThingTemplate.cpp.

◆ parseWeaponTemplateSet()

void ThingTemplate::parseWeaponTemplateSet ( INI * ini,
void * instance,
void * store,
const void *  )
staticprotected

Definition at line 928 of file ThingTemplate.cpp.

◆ removeModuleInfo()

Bool ThingTemplate::removeModuleInfo ( const AsciiString & moduleToRemove,
AsciiString & clearedModuleNameOut )
protected

Remove the module whose tag matches moduleToRemove.

Definition at line 857 of file ThingTemplate.cpp.

◆ resolveNames()

void ThingTemplate::resolveNames ( )

called by ThingFactory after all templates have been loaded.

Definition at line 1254 of file ThingTemplate.cpp.

◆ setCopiedFromDefault()

void ThingTemplate::setCopiedFromDefault ( )

Definition at line 1236 of file ThingTemplate.cpp.

◆ setReskinnedFrom()

void ThingTemplate::setReskinnedFrom ( const ThingTemplate * tt)
inline

Definition at line 602 of file ThingTemplate.h.

◆ validate()

void ThingTemplate::validate ( )

Definition at line 1142 of file ThingTemplate.cpp.

◆ validateAudio()

void ThingTemplate::validateAudio ( )
protected

Definition at line 1069 of file ThingTemplate.cpp.

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