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

This is the info for creating reinforcement and AI teams. More...

#include <Team.h>

Inherits Snapshot.

Public Types

enum  { MAX_UNIT_TYPES = 7 }
 
enum  TBehavior { NORMAL =0 , IGNORE_DISTRACTIONS =1 , DEAL_AGGRESSIVELY =2 }
 

Public Member Functions

 TeamTemplateInfo (Dict *d)
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Public Attributes

TCreateUnitsInfo m_unitsInfo [MAX_UNIT_TYPES]
 Quantity of units to create or build.
 
Int m_numUnitsInfo
 Number of entries in m_unitsInfo.
 
Coord3D m_homeLocation
 Spawn location for team.
 
Bool m_hasHomeLocation
 True is m_homeLocation is valid.
 
AsciiString m_scriptOnCreate
 Script executed when team is created.
 
AsciiString m_scriptOnIdle
 Script executed when team is idle.
 
Int m_initialIdleFrames
 Number of frames to continue recruiting after the minimum team size is achieved.
 
AsciiString m_scriptOnEnemySighted
 Script executed when enemy is sighted.
 
AsciiString m_scriptOnAllClear
 Script executed when enemy is sighted.
 
AsciiString m_scriptOnUnitDestroyed
 Script executed each time a unit on this team dies.
 
AsciiString m_scriptOnDestroyed
 Script executed m_destroyedThreshold of member units are destroyed.
 
Real m_destroyedThreshold
 OnDestroyed threshold - 1.0 = 100% = all destroyed, .5 = 50% = half of the units destroyed, 0 = useless.
 
Bool m_isAIRecruitable
 True if other ai teams can recruit.
 
Bool m_isBaseDefense
 True if is base defense team.
 
Bool m_isPerimeterDefense
 True if is a perimeter base defense team.
 
Bool m_automaticallyReinforce
 True is team automatically tries to reinforce.
 
Bool m_transportsReturn
 True if transports return to base after unloading.
 
Bool m_avoidThreats
 True if the team avoids threats.
 
Bool m_attackCommonTarget
 True if the team attacks the same target unit.
 
Int m_maxInstances
 Maximum number of instances of a team that is not singleton.
 
Int m_productionPriority
 Production priority.
 
Int m_productionPrioritySuccessIncrease
 Production priority increase on success.
 
Int m_productionPriorityFailureDecrease
 Production priority decrease on failure.
 
AttitudeType m_initialTeamAttitude
 The initial team attitude.
 
AsciiString m_transportUnitType
 Unit used to transport the team.
 
AsciiString m_startReinforceWaypoint
 Waypoint where the reinforcement team starts.
 
Bool m_teamStartsFull
 If true, team loads into member transports.
 
Bool m_transportsExit
 True if the transports leave after deploying team.
 
VeterancyLevel m_veterancy
 Veterancy level;.
 
AsciiString m_productionCondition
 Script that contains the production conditions.
 
Bool m_executeActions
 If this is true, then when the production condition becomes true, we also execute the actions.
 
AsciiString m_teamGenericScripts [MAX_GENERIC_SCRIPTS]
 

Protected Member Functions

virtual void crc (Xfer *xfer)
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 

Detailed Description

This is the info for creating reinforcement and AI teams.

Definition at line 125 of file Team.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MAX_UNIT_TYPES 

Definition at line 132 of file Team.h.

◆ TBehavior

enum TeamTemplateInfo::TBehavior
Enumerator
NORMAL 
IGNORE_DISTRACTIONS 
DEAL_AGGRESSIVELY 

Definition at line 133 of file Team.h.

Constructor & Destructor Documentation

◆ TeamTemplateInfo()

TeamTemplateInfo::TeamTemplateInfo ( Dict * d)

Definition at line 617 of file Team.cpp.

Member Function Documentation

◆ crc()

void TeamTemplateInfo::crc ( Xfer * xfer)
protectedvirtual

CRC

Implements Snapshot.

Definition at line 767 of file Team.cpp.

◆ loadPostProcess()

void TeamTemplateInfo::loadPostProcess ( void )
protectedvirtual

Load post process

Implements Snapshot.

Definition at line 793 of file Team.cpp.

◆ xfer()

void TeamTemplateInfo::xfer ( Xfer * xfer)
protectedvirtual

Xfer method Version Info: 1: Initial version

Implements Snapshot.

Definition at line 777 of file Team.cpp.

Member Data Documentation

◆ m_attackCommonTarget

Bool TeamTemplateInfo::m_attackCommonTarget

True if the team attacks the same target unit.

Definition at line 153 of file Team.h.

◆ m_automaticallyReinforce

Bool TeamTemplateInfo::m_automaticallyReinforce

True is team automatically tries to reinforce.

Definition at line 150 of file Team.h.

◆ m_avoidThreats

Bool TeamTemplateInfo::m_avoidThreats

True if the team avoids threats.

Definition at line 152 of file Team.h.

◆ m_destroyedThreshold

Real TeamTemplateInfo::m_destroyedThreshold

OnDestroyed threshold - 1.0 = 100% = all destroyed, .5 = 50% = half of the units destroyed, 0 = useless.

Definition at line 146 of file Team.h.

◆ m_executeActions

Bool TeamTemplateInfo::m_executeActions

If this is true, then when the production condition becomes true, we also execute the actions.

Definition at line 168 of file Team.h.

◆ m_hasHomeLocation

Bool TeamTemplateInfo::m_hasHomeLocation

True is m_homeLocation is valid.

Definition at line 138 of file Team.h.

◆ m_homeLocation

Coord3D TeamTemplateInfo::m_homeLocation

Spawn location for team.

Definition at line 137 of file Team.h.

◆ m_initialIdleFrames

Int TeamTemplateInfo::m_initialIdleFrames

Number of frames to continue recruiting after the minimum team size is achieved.

Definition at line 141 of file Team.h.

◆ m_initialTeamAttitude

AttitudeType TeamTemplateInfo::m_initialTeamAttitude

The initial team attitude.

Definition at line 158 of file Team.h.

◆ m_isAIRecruitable

Bool TeamTemplateInfo::m_isAIRecruitable

True if other ai teams can recruit.

Definition at line 147 of file Team.h.

◆ m_isBaseDefense

Bool TeamTemplateInfo::m_isBaseDefense

True if is base defense team.

Definition at line 148 of file Team.h.

◆ m_isPerimeterDefense

Bool TeamTemplateInfo::m_isPerimeterDefense

True if is a perimeter base defense team.

Definition at line 149 of file Team.h.

◆ m_maxInstances

Int TeamTemplateInfo::m_maxInstances

Maximum number of instances of a team that is not singleton.

Definition at line 154 of file Team.h.

◆ m_numUnitsInfo

Int TeamTemplateInfo::m_numUnitsInfo

Number of entries in m_unitsInfo.

Definition at line 136 of file Team.h.

◆ m_productionCondition

AsciiString TeamTemplateInfo::m_productionCondition

Script that contains the production conditions.

Definition at line 167 of file Team.h.

◆ m_productionPriority

Int TeamTemplateInfo::m_productionPriority
mutable

Production priority.

Definition at line 155 of file Team.h.

◆ m_productionPriorityFailureDecrease

Int TeamTemplateInfo::m_productionPriorityFailureDecrease

Production priority decrease on failure.

Definition at line 157 of file Team.h.

◆ m_productionPrioritySuccessIncrease

Int TeamTemplateInfo::m_productionPrioritySuccessIncrease

Production priority increase on success.

Definition at line 156 of file Team.h.

◆ m_scriptOnAllClear

AsciiString TeamTemplateInfo::m_scriptOnAllClear

Script executed when enemy is sighted.

Definition at line 143 of file Team.h.

◆ m_scriptOnCreate

AsciiString TeamTemplateInfo::m_scriptOnCreate

Script executed when team is created.

Definition at line 139 of file Team.h.

◆ m_scriptOnDestroyed

AsciiString TeamTemplateInfo::m_scriptOnDestroyed

Script executed m_destroyedThreshold of member units are destroyed.

Definition at line 145 of file Team.h.

◆ m_scriptOnEnemySighted

AsciiString TeamTemplateInfo::m_scriptOnEnemySighted

Script executed when enemy is sighted.

Definition at line 142 of file Team.h.

◆ m_scriptOnIdle

AsciiString TeamTemplateInfo::m_scriptOnIdle

Script executed when team is idle.

Definition at line 140 of file Team.h.

◆ m_scriptOnUnitDestroyed

AsciiString TeamTemplateInfo::m_scriptOnUnitDestroyed

Script executed each time a unit on this team dies.

Definition at line 144 of file Team.h.

◆ m_startReinforceWaypoint

AsciiString TeamTemplateInfo::m_startReinforceWaypoint

Waypoint where the reinforcement team starts.

Definition at line 161 of file Team.h.

◆ m_teamGenericScripts

AsciiString TeamTemplateInfo::m_teamGenericScripts[MAX_GENERIC_SCRIPTS]

Definition at line 170 of file Team.h.

◆ m_teamStartsFull

Bool TeamTemplateInfo::m_teamStartsFull

If true, team loads into member transports.

Definition at line 162 of file Team.h.

◆ m_transportsExit

Bool TeamTemplateInfo::m_transportsExit

True if the transports leave after deploying team.

Definition at line 163 of file Team.h.

◆ m_transportsReturn

Bool TeamTemplateInfo::m_transportsReturn

True if transports return to base after unloading.

Definition at line 151 of file Team.h.

◆ m_transportUnitType

AsciiString TeamTemplateInfo::m_transportUnitType

Unit used to transport the team.

Definition at line 160 of file Team.h.

◆ m_unitsInfo

TCreateUnitsInfo TeamTemplateInfo::m_unitsInfo[MAX_UNIT_TYPES]

Quantity of units to create or build.

Definition at line 135 of file Team.h.

◆ m_veterancy

VeterancyLevel TeamTemplateInfo::m_veterancy

Veterancy level;.

Definition at line 164 of file Team.h.

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