#include <ScriptEngine.h>

Inherits SubsystemInterface, and Snapshot.

Public Types
enum	{ MAX_COUNTERS =256 , MAX_FLAGS =256 , MAX_ATTACK_PRIORITIES =256 }

enum	TFade { FADE_NONE , FADE_SUBTRACT , FADE_ADD , FADE_SATURATE , FADE_MULTIPLY }

Public Member Functions
	ScriptEngine ()

virtual	~ScriptEngine ()

virtual void	init (void)
	Init.

virtual void	reset (void)
	Reset.

virtual void	update (void)
	Update.

void	appendSequentialScript (const SequentialScript *scriptToSequence)

void	removeSequentialScript (SequentialScript *scriptToRemove)

void	notifyOfTeamDestruction (Team *teamDestroyed)

void	notifyOfObjectCreationOrDestruction (void)

UnsignedInt	getFrameObjectCountChanged (void)

void	setSequentialTimer (Object *obj, Int frameCount)

void	setSequentialTimer (Team *team, Int frameCount)

void	removeAllSequentialScripts (Object *obj)

void	removeAllSequentialScripts (Team *team)

AsciiString	getStats (Real curTime, Real script1Time, Real *script2Time)

virtual void	newMap ()
	reset script engine for new map

virtual const ActionTemplate *	getActionTemplate (Int ndx)
	Get the template for a script action.

virtual const ConditionTemplate *	getConditionTemplate (Int ndx)
	Get the template for a script Condition.

virtual void	startEndGameTimer (void)
	Starts the end game timer after a mission is won or lost.

Bool	isGameEnding (void)

virtual void	startQuickEndGameTimer (void)
	Starts the quick end game timer after a campaign is won or lost.

virtual void	startCloseWindowTimer (void)
	Starts the timer to close windows after a mission is won or lost.

virtual void	runScript (const AsciiString &scriptName, Team *pThisTeam=NULL)
	Runs a script.

virtual void	runObjectScript (const AsciiString &scriptName, Object *pThisObject=NULL)
	Runs a script attached to this object.

virtual Team *	getTeamNamed (const AsciiString &teamName)
	Gets the named team. May be null.

virtual Player *	getSkirmishEnemyPlayer (void)
	Gets the ai's enemy Human player. May be null.

virtual Player *	getCurrentPlayer (void)
	Gets the player that owns the current script. May be null.

virtual Player *	getPlayerFromAsciiString (const AsciiString &skirmishPlayerString)

void	setObjectsShouldReceiveDifficultyBonus (Bool receive)

Bool	getObjectsShouldReceiveDifficultyBonus () const

void	setChooseVictimAlwaysUsesNormal (Bool receive)

Bool	getChooseVictimAlwaysUsesNormal () const

Bool	hasShownMPLocalDefeatWindow (void)

void	markMPLocalDefeatWindowShown (void)

virtual ObjectTypes *	getObjectTypes (const AsciiString &objectTypeList)

virtual void	doObjectTypeListMaintenance (const AsciiString &objectTypeList, const AsciiString &objectType, Bool addObject)

virtual PolygonTrigger *	getQualifiedTriggerAreaByName (AsciiString name)
	Return the trigger area with the given name.

virtual Bool	evaluateConditions (Script pScript, Team pThisTeam=NULL, Player *pPlayer=NULL)
	< if pThisTeam is specified, then scripts in here can use <This Team> to mean the team this script is attached to.

virtual void	friend_executeAction (ScriptAction pActionHead, Team pThisTeam=NULL)
	Use this at yer peril.

virtual Object *	getUnitNamed (const AsciiString &unitName)
	Gets the named unit. May be null.

virtual Bool	didUnitExist (const AsciiString &unitName)

virtual void	addObjectToCache (Object *pNewObject)

virtual void	removeObjectFromCache (Object *pDeadObject)

virtual void	transferObjectName (const AsciiString &unitName, Object *pNewObject)

virtual void	notifyOfObjectDestruction (Object *pDeadObject)

virtual void	notifyOfCompletedVideo (const AsciiString &completedVideo)
	Notify the script engine that a video has completed.

virtual void	notifyOfTriggeredSpecialPower (Int playerIndex, const AsciiString &completedPower, ObjectID sourceObj)

virtual void	notifyOfMidwaySpecialPower (Int playerIndex, const AsciiString &completedPower, ObjectID sourceObj)

virtual void	notifyOfCompletedSpecialPower (Int playerIndex, const AsciiString &completedPower, ObjectID sourceObj)

virtual void	notifyOfCompletedUpgrade (Int playerIndex, const AsciiString &upgrade, ObjectID sourceObj)

virtual void	notifyOfAcquiredScience (Int playerIndex, ScienceType science)

virtual void	signalUIInteract (const AsciiString &hookName)
	Notify that a UI button was pressed and some flag should go true, for one frame only.

virtual Bool	isVideoComplete (const AsciiString &completedVideo, Bool removeFromList)
	Determine whether a video has completed.

virtual Bool	isSpeechComplete (const AsciiString &completedSpeech, Bool removeFromList)
	Determine whether a speech has completed.

virtual Bool	isAudioComplete (const AsciiString &completedAudio, Bool removeFromList)
	Determine whether a sound has completed.

virtual Bool	isSpecialPowerTriggered (Int playerIndex, const AsciiString &completedPower, Bool removeFromList, ObjectID sourceObj)

virtual Bool	isSpecialPowerMidway (Int playerIndex, const AsciiString &completedPower, Bool removeFromList, ObjectID sourceObj)

virtual Bool	isSpecialPowerComplete (Int playerIndex, const AsciiString &completedPower, Bool removeFromList, ObjectID sourceObj)

virtual Bool	isUpgradeComplete (Int playerIndex, const AsciiString &upgrade, Bool removeFromList, ObjectID sourceObj)

virtual Bool	isScienceAcquired (Int playerIndex, ScienceType science, Bool removeFromList)

void	setToppleDirection (const AsciiString &objectName, const Coord3D *direction)

virtual void	adjustToppleDirection (Object object, Coord2D direction)

virtual void	adjustToppleDirection (Object object, Coord3D direction)

virtual const Script *	findScriptByName (const AsciiString &scriptName)
	Finds a script.

const BreezeInfo &	getBreezeInfo () const

void	turnBreezeOff (void)

Bool	isTimeFrozenScript (void)
	Ask whether a script has frozen time or not.

void	doFreezeTime (void)

void	doUnfreezeTime (void)

Bool	isTimeFrozenDebug (void)
	The following functions are used to update and query the debug window.

Bool	isTimeFast (void)
	Ask whether the debug window has requested a fast forward.

void	forceUnfreezeTime (void)
	Force that time becomes unfrozen temporarily.

void	AppendDebugMessage (const AsciiString &strToAdd, Bool forcePause)

void	AdjustDebugVariableData (const AsciiString &variableName, Int value, Bool forcePause)

void	clearTeamFlags (void)
	Hack for dustin.

void	clearFlag (const AsciiString &name)
	Hack for dustin.

TFade	getFade (void)

Real	getFadeValue (void)

AsciiString	getCurrentTrackName () const

void	setCurrentTrackName (AsciiString a)

GameDifficulty	getGlobalDifficulty (void) const

void	setGlobalDifficulty (GameDifficulty difficulty)

const AttackPriorityInfo *	getDefaultAttackInfo (void)
	Attack priority stuff.

const AttackPriorityInfo *	getAttackInfo (const AsciiString &name)

const TCounter *	getCounter (const AsciiString &counterName)

void	createNamedMapReveal (const AsciiString &revealName, const AsciiString &waypointName, Real radiusToReveal, const AsciiString &playerName)

void	doNamedMapReveal (const AsciiString &revealName)

void	undoNamedMapReveal (const AsciiString &revealName)

void	removeNamedMapReveal (const AsciiString &revealName)

Int	getObjectCount (Int playerIndex, const AsciiString &objectTypeName) const

void	setObjectCount (Int playerIndex, const AsciiString &objectTypeName, Int newCount)

void	createNamedCache (void)

void	setEnableVTune (Bool value)
	Begin VTUNE.

Bool	getEnableVTune () const

void	debugVictory (void)
	End VTUNE.

Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()

virtual	~SubsystemInterface ()

virtual void	postProcessLoad ()

virtual void	draw (void)

void	UPDATE (void)

void	DRAW (void)

AsciiString	getName (void)

void	setName (AsciiString name)

Public Member Functions inherited from Snapshot
	Snapshot (void)

	~Snapshot (void)

Static Public Member Functions
static void	parseScriptAction (INI *ini)

static void	parseScriptCondition (INI *ini)

Protected Types
typedef std::vector< SequentialScript * >	VecSequentialScriptPtr
	Stuff to execute scripts sequentially.

typedef VecSequentialScriptPtr::iterator	VecSequentialScriptPtrIt

Protected Member Functions
virtual void	crc (Xfer *xfer)

virtual void	xfer (Xfer *xfer)

virtual void	loadPostProcess (void)

void	addActionTemplateInfo (Template *actionTemplate)

void	addConditionTemplateInfo (Template *conditionTemplate)

Int	allocateCounter (const AsciiString &name)

Int	allocateFlag (const AsciiString &name)

void	executeScripts (Script *pScriptHead)

void	executeScript (Script *pScript)

Script *	findScript (const AsciiString &name)

ScriptGroup *	findGroup (const AsciiString &name)

void	setSway (ScriptAction *pAction)

void	setCounter (ScriptAction *pAction)

void	addCounter (ScriptAction *pAction)

void	subCounter (ScriptAction *pAction)

void	setFade (ScriptAction *pAction)

void	setFlag (ScriptAction *pAction)

void	pauseTimer (ScriptAction *pAction)

void	restartTimer (ScriptAction *pAction)

void	setTimer (ScriptAction *pAction, Bool milisecondTimer, Bool random)

void	adjustTimer (ScriptAction *pAction, Bool milisecondTimer, Bool add)

void	enableScript (ScriptAction *pAction)

void	disableScript (ScriptAction *pAction)

void	callSubroutine (ScriptAction *pAction)

void	checkConditionsForTeamNames (Script *pScript)

Bool	evaluateCounter (Condition *pCondition)

Bool	evaluateFlag (Condition *pCondition)

Bool	evaluateTimer (Condition *pCondition)

Bool	evaluateCondition (Condition *pCondition)

void	executeActions (ScriptAction *pActionHead)

void	setPriorityThing (ScriptAction *pAction)

void	setPriorityKind (ScriptAction *pAction)

void	setPriorityDefault (ScriptAction *pAction)

void	removeObjectTypes (ObjectTypes *typesToRemove)

void	particleEditorUpdate (void)

void	updateFades (void)

AttackPriorityInfo *	findAttackInfo (const AsciiString &name, Bool addIfNotFound)

void	evaluateAndProgressAllSequentialScripts (void)

VecSequentialScriptPtrIt	cleanupSequentialScript (VecSequentialScriptPtrIt it, Bool cleanDanglers)

Bool	hasUnitCompletedSequentialScript (Object *object, const AsciiString &sequentialScriptName)

Bool	hasTeamCompletedSequentialScript (Team *team, const AsciiString &sequentialScriptName)

Protected Attributes
VecSequentialScriptPtr	m_sequentialScripts

ActionTemplate	m_actionTemplates [ScriptAction::NUM_ITEMS]

ConditionTemplate	m_conditionTemplates [Condition::NUM_ITEMS]

TCounter	m_counters [MAX_COUNTERS]

Int	m_numCounters

TFlag	m_flags [MAX_FLAGS]

Int	m_numFlags

AttackPriorityInfo	m_attackPriorityInfo [MAX_ATTACK_PRIORITIES]

Int	m_numAttackInfo

Int	m_endGameTimer

Int	m_closeWindowTimer

Team *	m_callingTeam
	Team that is calling script, used for THIS_TEAM.

Object *	m_callingObject
	Object that is calling script, used for THIS_OBJECT.

Team *	m_conditionTeam
	Team that is being used to evaluate conditions, used for THIS_TEAM.

Object *	m_conditionObject
	Unit that is being used to evaluate conditions, used for THIS_OBJECT.

VecNamedRequests	m_namedObjects

Bool	m_firstUpdate

Player *	m_currentPlayer

Player *	m_skirmishHumanPlayer

AsciiString	m_currentTrackName

TFade	m_fade

Real	m_minFade

Real	m_maxFade

Real	m_curFadeValue

Int	m_curFadeFrame

Int	m_fadeFramesIncrease

Int	m_fadeFramesHold

Int	m_fadeFramesDecrease

UnsignedInt	m_frameObjectCountChanged

ObjectTypeCount	m_objectCounts [MAX_PLAYER_COUNT]

ListAsciiString	m_completedVideo
	These are three separate lists rather than one to increase speed efficiency.

ListAsciiStringUINT	m_testingSpeech

ListAsciiStringUINT	m_testingAudio

ListAsciiString	m_uiInteractions

ListAsciiStringObjectID	m_triggeredSpecialPowers [MAX_PLAYER_COUNT]

ListAsciiStringObjectID	m_midwaySpecialPowers [MAX_PLAYER_COUNT]

ListAsciiStringObjectID	m_finishedSpecialPowers [MAX_PLAYER_COUNT]

ListAsciiStringObjectID	m_completedUpgrades [MAX_PLAYER_COUNT]

ScienceVec	m_acquiredSciences [MAX_PLAYER_COUNT]

ListAsciiStringCoord3D	m_toppleDirections

VecNamedReveal	m_namedReveals

BreezeInfo	m_breezeInfo

GameDifficulty	m_gameDifficulty

Bool	m_freezeByScript

AllObjectTypes	m_allObjectTypeLists

Bool	m_objectsShouldReceiveDifficultyBonus

Bool	m_ChooseVictimAlwaysUsesNormal

Bool	m_shownMPLocalDefeatWindow

Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Implementation for the Script Engine singleton

Definition at line 219 of file ScriptEngine.h.

Member Typedef Documentation

◆ VecSequentialScriptPtr

typedef std::vector<SequentialScript*> ScriptEngine::VecSequentialScriptPtr

protected

Stuff to execute scripts sequentially.

Definition at line 417 of file ScriptEngine.h.

◆ VecSequentialScriptPtrIt

typedef VecSequentialScriptPtr::iterator ScriptEngine::VecSequentialScriptPtrIt

protected

Definition at line 418 of file ScriptEngine.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
MAX_COUNTERS
MAX_FLAGS
MAX_ATTACK_PRIORITIES

Definition at line 224 of file ScriptEngine.h.

◆ TFade

enum ScriptEngine::TFade

Enumerator
FADE_NONE
FADE_SUBTRACT
FADE_ADD
FADE_SATURATE
FADE_MULTIPLY

Definition at line 225 of file ScriptEngine.h.

Constructor & Destructor Documentation

◆ ScriptEngine()

ScriptEngine::ScriptEngine ( )

Definition at line 447 of file ScriptEngine.cpp.

◆ ~ScriptEngine()

ScriptEngine::~ScriptEngine ( )

virtual

Definition at line 486 of file ScriptEngine.cpp.

Member Function Documentation

◆ addActionTemplateInfo()

void ScriptEngine::addActionTemplateInfo ( Template * actionTemplate )

protected

Update the info from a script action's .ini entry. The InternalName has to match the action's internal name, and then it overrides the ui name and help text. If no entry is present in the ini file, the default code initialized value in ScriptEngine::init() is used. jba

Definition at line 394 of file ScriptEngine.cpp.

◆ addConditionTemplateInfo()

void ScriptEngine::addConditionTemplateInfo ( Template * actionTemplate )

protected

Update the info from a script action's .ini entry. The InternalName has to match the action's internal name, and then it overrides the ui name and help text. If no entry is present in the ini file, the default code initialized value in ScriptEngine::init() is used. jba

Definition at line 429 of file ScriptEngine.cpp.

◆ addCounter()

void ScriptEngine::addCounter ( ScriptAction * pAction )

protected

Adds to a counter.

Definition at line 6431 of file ScriptEngine.cpp.

◆ addObjectToCache()

void ScriptEngine::addObjectToCache ( Object * pNewObject )

virtual

adds an object to the cache, allowing it to be looked up by name

Definition at line 7092 of file ScriptEngine.cpp.

◆ AdjustDebugVariableData()

void ScriptEngine::AdjustDebugVariableData	(	const AsciiString &	variableName,
		Int	value,
		Bool	forcePause )

Definition at line 8517 of file ScriptEngine.cpp.

◆ adjustTimer()

void ScriptEngine::adjustTimer	(	ScriptAction *	pAction,
		Bool	millisecondTimer,
		Bool	add )

protected

adjusts a timer.

Definition at line 6797 of file ScriptEngine.cpp.

◆ adjustToppleDirection() [1/2]

void ScriptEngine::adjustToppleDirection	(	Object *	object,
		Coord2D *	direction )

virtual

if the object is named and has a specified topple direction, topple adjust direction to reflect /** it.

Definition at line 7543 of file ScriptEngine.cpp.

◆ adjustToppleDirection() [2/2]

void ScriptEngine::adjustToppleDirection	(	Object *	object,
		Coord3D *	direction )

virtual

if the object is named and has a specified topple direction, topple adjust direction to reflect /** it.

Definition at line 7561 of file ScriptEngine.cpp.

◆ allocateCounter()

Int ScriptEngine::allocateCounter ( const AsciiString & name )

protected

Allocates a counter, if this name doesn't exist.

Definition at line 6133 of file ScriptEngine.cpp.

◆ allocateFlag()

Int ScriptEngine::allocateFlag ( const AsciiString & name )

protected

Allocates a flag, if this name doesn't exist.

Definition at line 6271 of file ScriptEngine.cpp.

◆ AppendDebugMessage()

void ScriptEngine::AppendDebugMessage	(	const AsciiString &	strToAdd,
		Bool	forcePause )

Definition at line 8491 of file ScriptEngine.cpp.

◆ appendSequentialScript()

void ScriptEngine::appendSequentialScript ( const SequentialScript * scriptToSequence )

Definition at line 7738 of file ScriptEngine.cpp.

◆ callSubroutine()

void ScriptEngine::callSubroutine ( ScriptAction * pAction )

protected

Executes a script subroutine.

Definition at line 6853 of file ScriptEngine.cpp.

◆ checkConditionsForTeamNames()

void ScriptEngine::checkConditionsForTeamNames ( Script * pScript )

protected

Checks to see if any teams are referenced in the conditions, so we can properly iterate over multiple teams.

Definition at line 6891 of file ScriptEngine.cpp.

◆ cleanupSequentialScript()

ScriptEngine::VecSequentialScriptPtrIt ScriptEngine::cleanupSequentialScript	(	VecSequentialScriptPtrIt	it,
		Bool	cleanDanglers )

protected

Definition at line 8066 of file ScriptEngine.cpp.

◆ clearFlag()

void ScriptEngine::clearFlag ( const AsciiString & name )

Hack for dustin.

clearFlag

Definition at line 5768 of file ScriptEngine.cpp.

◆ clearTeamFlags()

void ScriptEngine::clearTeamFlags ( void )

Hack for dustin.

clearTeamFlags

Definition at line 5787 of file ScriptEngine.cpp.

◆ crc()

void ScriptEngine::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements Snapshot.

Definition at line 8525 of file ScriptEngine.cpp.

◆ createNamedCache()

void ScriptEngine::createNamedCache ( void )

Fills the named object cache initally.

Definition at line 7717 of file ScriptEngine.cpp.

◆ createNamedMapReveal()

void ScriptEngine::createNamedMapReveal	(	const AsciiString &	revealName,
		const AsciiString &	waypointName,
		Real	radiusToReveal,
		const AsciiString &	playerName )

Definition at line 6169 of file ScriptEngine.cpp.

◆ debugVictory()

void ScriptEngine::debugVictory ( void )

End VTUNE.

Definition at line 9335 of file ScriptEngine.cpp.

◆ didUnitExist()

Bool ScriptEngine::didUnitExist ( const AsciiString & unitName )

virtual

didUnitExist

Definition at line 6019 of file ScriptEngine.cpp.

◆ disableScript()

void ScriptEngine::disableScript ( ScriptAction * pAction )

protected

Enables a script or group.

Definition at line 6837 of file ScriptEngine.cpp.

◆ doFreezeTime()

void ScriptEngine::doFreezeTime ( void )

Freeze time

Definition at line 8413 of file ScriptEngine.cpp.

◆ doNamedMapReveal()

void ScriptEngine::doNamedMapReveal ( const AsciiString & revealName )

Definition at line 6190 of file ScriptEngine.cpp.

◆ doObjectTypeListMaintenance()

void ScriptEngine::doObjectTypeListMaintenance	(	const AsciiString &	objectTypeList,
		const AsciiString &	objectType,
		Bool	addObject )

virtual

doObjectTypeListMaintenance If addObject is false, remove the object. If it is true, add the object. If the object removed is the last object, then the list is removed as well.

Definition at line 5883 of file ScriptEngine.cpp.

◆ doUnfreezeTime()

void ScriptEngine::doUnfreezeTime ( void )

Unfreeze time

Definition at line 8421 of file ScriptEngine.cpp.

◆ enableScript()

void ScriptEngine::enableScript ( ScriptAction * pAction )

protected

Enables a script or group.

Definition at line 6821 of file ScriptEngine.cpp.

◆ evaluateAndProgressAllSequentialScripts()

void ScriptEngine::evaluateAndProgressAllSequentialScripts ( void )

protected

Definition at line 7884 of file ScriptEngine.cpp.

◆ evaluateCondition()

Bool ScriptEngine::evaluateCondition ( Condition * pCondition )

protected

Evaluates a condition

Definition at line 7059 of file ScriptEngine.cpp.

◆ evaluateConditions()

Bool ScriptEngine::evaluateConditions	(	Script *	pScript,
		Team *	thisTeam = NULL,
		Player *	player = NULL )

virtual

< if pThisTeam is specified, then scripts in here can use <This Team> to mean the team this script is attached to.

Evaluates a list of conditions

Definition at line 7582 of file ScriptEngine.cpp.

◆ evaluateCounter()

Bool ScriptEngine::evaluateCounter ( Condition * pCondition )

protected

Evaluates a counter condition

Definition at line 6339 of file ScriptEngine.cpp.

◆ evaluateFlag()

Bool ScriptEngine::evaluateFlag ( Condition * pCondition )

protected

Evaluates a flag

Definition at line 6461 of file ScriptEngine.cpp.

◆ evaluateTimer()

Bool ScriptEngine::evaluateTimer ( Condition * pCondition )

protected

Evaluates a timer

Definition at line 6718 of file ScriptEngine.cpp.

◆ executeActions()

void ScriptEngine::executeActions ( ScriptAction * pActionHead )

protected

Execute a linked list of actions

Definition at line 7633 of file ScriptEngine.cpp.

◆ executeScript()

void ScriptEngine::executeScript ( Script * pScript )

protected

Executes a script.

Definition at line 6950 of file ScriptEngine.cpp.

◆ executeScripts()

void ScriptEngine::executeScripts ( Script * pScriptHead )

protected

Execute a linked list of scripts

Definition at line 7677 of file ScriptEngine.cpp.

◆ findAttackInfo()

AttackPriorityInfo * ScriptEngine::findAttackInfo	(	const AsciiString &	name,
		Bool	addIfNotFound )

protected

Finds a named attack info. Note - may return null.

Definition at line 6507 of file ScriptEngine.cpp.

◆ findGroup()

ScriptGroup * ScriptEngine::findGroup ( const AsciiString & name )

protected

Locates a group by name.

Definition at line 6293 of file ScriptEngine.cpp.

◆ findScript()

Script * ScriptEngine::findScript ( const AsciiString & name )

protected

Locates a script by name.

Definition at line 6312 of file ScriptEngine.cpp.

◆ findScriptByName()

virtual const Script * ScriptEngine::findScriptByName ( const AsciiString & scriptName )

inlinevirtual

Finds a script.

Definition at line 310 of file ScriptEngine.h.

◆ forceUnfreezeTime()

void ScriptEngine::forceUnfreezeTime ( void )

Force that time becomes unfrozen temporarily.

Definition at line 8479 of file ScriptEngine.cpp.

◆ friend_executeAction()

void ScriptEngine::friend_executeAction	(	ScriptAction *	pActionHead,
		Team *	pThisTeam = NULL )

virtual

Use this at yer peril.

Execute an action specified by pActionHead

Definition at line 7075 of file ScriptEngine.cpp.

◆ getActionTemplate()

const ActionTemplate * ScriptEngine::getActionTemplate ( Int ndx )

virtual

Get the template for a script action.

Gets the ui and parameter template for a script action

Definition at line 7694 of file ScriptEngine.cpp.

◆ getAttackInfo()

const AttackPriorityInfo * ScriptEngine::getAttackInfo ( const AsciiString & name )

Returns the named attack info, if non-existent returns default attack priority info.
Never returns null.

Definition at line 6538 of file ScriptEngine.cpp.

◆ getBreezeInfo()

const BreezeInfo & ScriptEngine::getBreezeInfo ( ) const

inline

Definition at line 312 of file ScriptEngine.h.

◆ getChooseVictimAlwaysUsesNormal()

Bool ScriptEngine::getChooseVictimAlwaysUsesNormal ( ) const

inline

Definition at line 264 of file ScriptEngine.h.

◆ getConditionTemplate()

const ConditionTemplate * ScriptEngine::getConditionTemplate ( Int ndx )

virtual

Get the template for a script Condition.

Gets the ui and parameter template for a script condition

Definition at line 7706 of file ScriptEngine.cpp.

◆ getCounter()

const TCounter * ScriptEngine::getCounter ( const AsciiString & counterName )

Gets a counter

Definition at line 6155 of file ScriptEngine.cpp.

◆ getCurrentPlayer()

Player * ScriptEngine::getCurrentPlayer ( void )

virtual

Gets the player that owns the current script. May be null.

getCurrentPlayer

Definition at line 5758 of file ScriptEngine.cpp.

◆ getCurrentTrackName()

AsciiString ScriptEngine::getCurrentTrackName ( ) const

inline

Definition at line 332 of file ScriptEngine.h.

◆ getDefaultAttackInfo()

const AttackPriorityInfo * ScriptEngine::getDefaultAttackInfo ( void )

Attack priority stuff.

Returns the default attack priority info. Never returns null.

Definition at line 6528 of file ScriptEngine.cpp.

◆ getEnableVTune()

Bool ScriptEngine::getEnableVTune ( ) const

Definition at line 8110 of file ScriptEngine.cpp.

◆ getFade()

TFade ScriptEngine::getFade ( void )

inline

Definition at line 329 of file ScriptEngine.h.

◆ getFadeValue()

Real ScriptEngine::getFadeValue ( void )

inline

Definition at line 330 of file ScriptEngine.h.

◆ getFrameObjectCountChanged()

UnsignedInt ScriptEngine::getFrameObjectCountChanged ( void )

inline

Definition at line 237 of file ScriptEngine.h.

◆ getGlobalDifficulty()

GameDifficulty ScriptEngine::getGlobalDifficulty ( void ) const

inline

Definition at line 335 of file ScriptEngine.h.

◆ getObjectCount()

Int ScriptEngine::getObjectCount	(	Int	playerIndex,
		const AsciiString &	objectTypeName ) const

Definition at line 6665 of file ScriptEngine.cpp.

◆ getObjectsShouldReceiveDifficultyBonus()

Bool ScriptEngine::getObjectsShouldReceiveDifficultyBonus ( ) const

inline

Definition at line 261 of file ScriptEngine.h.

◆ getObjectTypes()

ObjectTypes * ScriptEngine::getObjectTypes ( const AsciiString & objectTypeList )

virtual

getObjectTypeList

Definition at line 5860 of file ScriptEngine.cpp.

◆ getPlayerFromAsciiString()

Player * ScriptEngine::getPlayerFromAsciiString ( const AsciiString & playerString )

virtual

getPlayerFromAsciiString

Definition at line 5832 of file ScriptEngine.cpp.

◆ getQualifiedTriggerAreaByName()

PolygonTrigger * ScriptEngine::getQualifiedTriggerAreaByName ( AsciiString name )

virtual

Return the trigger area with the given name.

Given a name, return the associated trigger area, or NULL if one doesn't exist. Handles skirmish name qualification.

Definition at line 5912 of file ScriptEngine.cpp.

◆ getSkirmishEnemyPlayer()

Player * ScriptEngine::getSkirmishEnemyPlayer ( void )

virtual

Gets the ai's enemy Human player. May be null.

getSkirmishEnemyPlayer

Definition at line 5803 of file ScriptEngine.cpp.

◆ getStats()

AsciiString ScriptEngine::getStats	(	Real *	curTimePtr,
		Real *	script1Time,
		Real *	script2Time )

getStats

Definition at line 5646 of file ScriptEngine.cpp.

◆ getTeamNamed()

Team * ScriptEngine::getTeamNamed ( const AsciiString & teamName )

virtual

Gets the named team. May be null.

getTeamNamed

Definition at line 5957 of file ScriptEngine.cpp.

◆ getUnitNamed()

Object * ScriptEngine::getUnitNamed ( const AsciiString & unitName )

virtual

Gets the named unit. May be null.

getUnitNamed

Definition at line 5999 of file ScriptEngine.cpp.

◆ hasShownMPLocalDefeatWindow()

Bool ScriptEngine::hasShownMPLocalDefeatWindow ( void )

Definition at line 9342 of file ScriptEngine.cpp.

◆ hasTeamCompletedSequentialScript()

Bool ScriptEngine::hasTeamCompletedSequentialScript	(	Team *	team,
		const AsciiString &	sequentialScriptName )

protected

Definition at line 8104 of file ScriptEngine.cpp.

◆ hasUnitCompletedSequentialScript()

Bool ScriptEngine::hasUnitCompletedSequentialScript	(	Object *	object,
		const AsciiString &	sequentialScriptName )

protected

Definition at line 8098 of file ScriptEngine.cpp.

◆ init()

void ScriptEngine::init ( void )

virtual

Init.

Init

Implements SubsystemInterface.

Definition at line 532 of file ScriptEngine.cpp.

◆ isAudioComplete()

Bool ScriptEngine::isAudioComplete	(	const AsciiString &	testAudio,
		Bool	removeFromList )

virtual

Determine whether a sound has completed.

Determine whether a sound has completed

Definition at line 7327 of file ScriptEngine.cpp.

◆ isGameEnding()

Bool ScriptEngine::isGameEnding ( void )

inline

Definition at line 250 of file ScriptEngine.h.

◆ isScienceAcquired()

Bool ScriptEngine::isScienceAcquired	(	Int	playerIndex,
		ScienceType	science,
		Bool	removeFromList )

virtual

Determine whether a science has been chosen

Definition at line 7488 of file ScriptEngine.cpp.

◆ isSpecialPowerComplete()

Bool ScriptEngine::isSpecialPowerComplete	(	Int	playerIndex,
		const AsciiString &	completedPower,
		Bool	removeFromList,
		ObjectID	sourceObj )

virtual

Determine whether a special power has been finished

Definition at line 7412 of file ScriptEngine.cpp.

◆ isSpecialPowerMidway()

Bool ScriptEngine::isSpecialPowerMidway	(	Int	playerIndex,
		const AsciiString &	completedPower,
		Bool	removeFromList,
		ObjectID	sourceObj )

virtual

Determine whether a special power has reached a midpoint (not required for all special powers!)

Definition at line 7387 of file ScriptEngine.cpp.

◆ isSpecialPowerTriggered()

Bool ScriptEngine::isSpecialPowerTriggered	(	Int	playerIndex,
		const AsciiString &	completedPower,
		Bool	removeFromList,
		ObjectID	sourceObj )

virtual

Determine whether a special power has been started

Definition at line 7362 of file ScriptEngine.cpp.

◆ isSpeechComplete()

Bool ScriptEngine::isSpeechComplete	(	const AsciiString &	testSpeech,
		Bool	removeFromList )

virtual

Determine whether a speech has completed.

Determine whether a speech has completed

Definition at line 7292 of file ScriptEngine.cpp.

◆ isTimeFast()

Bool ScriptEngine::isTimeFast ( void )

Ask whether the debug window has requested a fast forward.

For Debug and Internal builds, returns whether we are running fast (skipping draw)

Definition at line 8453 of file ScriptEngine.cpp.

◆ isTimeFrozenDebug()

Bool ScriptEngine::isTimeFrozenDebug ( void )

The following functions are used to update and query the debug window.

Ask whether the debug window has requested a pause.

For Debug and Internal builds, returns whether to continue (!pause), for release, returns false

Definition at line 8429 of file ScriptEngine.cpp.

◆ isTimeFrozenScript()

Bool ScriptEngine::isTimeFrozenScript ( void )

Ask whether a script has frozen time or not.

Is time frozen by a script?

Definition at line 8405 of file ScriptEngine.cpp.

◆ isUpgradeComplete()

Bool ScriptEngine::isUpgradeComplete	(	Int	playerIndex,
		const AsciiString &	upgrade,
		Bool	removeFromList,
		ObjectID	sourceObj )

virtual

Determine whether an upgrade has been completed

Definition at line 7437 of file ScriptEngine.cpp.

◆ isVideoComplete()

Bool ScriptEngine::isVideoComplete	(	const AsciiString &	completedVideo,
		Bool	removeFromList )

virtual

Determine whether a video has completed.

Determine whether a video has completed

Definition at line 7277 of file ScriptEngine.cpp.

◆ loadPostProcess()

void ScriptEngine::loadPostProcess ( void )

protectedvirtual

Load post process

Implements Snapshot.

Definition at line 9318 of file ScriptEngine.cpp.

◆ markMPLocalDefeatWindowShown()

void ScriptEngine::markMPLocalDefeatWindowShown ( void )

Definition at line 9347 of file ScriptEngine.cpp.

◆ newMap()

void ScriptEngine::newMap ( void )

virtual

reset script engine for new map

newMap

Definition at line 5433 of file ScriptEngine.cpp.

◆ notifyOfAcquiredScience()

void ScriptEngine::notifyOfAcquiredScience	(	Int	playerIndex,
		ScienceType	science )

virtual

Notify the script engine that a general was chosen fired

Definition at line 7258 of file ScriptEngine.cpp.

◆ notifyOfCompletedSpecialPower()

void ScriptEngine::notifyOfCompletedSpecialPower	(	Int	playerIndex,
		const AsciiString &	completedPower,
		ObjectID	sourceObj )

virtual

Notify the script engine that a special power fired

Definition at line 7242 of file ScriptEngine.cpp.

◆ notifyOfCompletedUpgrade()

void ScriptEngine::notifyOfCompletedUpgrade	(	Int	playerIndex,
		const AsciiString &	upgrade,
		ObjectID	sourceObj )

virtual

Notify the script engine that an upgrade finished

Definition at line 7250 of file ScriptEngine.cpp.

◆ notifyOfCompletedVideo()

void ScriptEngine::notifyOfCompletedVideo ( const AsciiString & completedVideo )

virtual

Notify the script engine that a video has completed.

Notify the script engine that a video has completed

Definition at line 7218 of file ScriptEngine.cpp.

◆ notifyOfMidwaySpecialPower()

void ScriptEngine::notifyOfMidwaySpecialPower	(	Int	playerIndex,
		const AsciiString &	completedPower,
		ObjectID	sourceObj )

virtual

Notify the script engine that a special power fired

Definition at line 7234 of file ScriptEngine.cpp.

◆ notifyOfObjectCreationOrDestruction()

void ScriptEngine::notifyOfObjectCreationOrDestruction ( void )

Definition at line 7809 of file ScriptEngine.cpp.

◆ notifyOfObjectDestruction()

void ScriptEngine::notifyOfObjectDestruction ( Object * pDeadObject )

virtual

Definition at line 7199 of file ScriptEngine.cpp.

◆ notifyOfTeamDestruction()

void ScriptEngine::notifyOfTeamDestruction ( Team * teamDestroyed )

Definition at line 7814 of file ScriptEngine.cpp.

◆ notifyOfTriggeredSpecialPower()

void ScriptEngine::notifyOfTriggeredSpecialPower	(	Int	playerIndex,
		const AsciiString &	completedPower,
		ObjectID	sourceObj )

virtual

Notify the script engine that a special power fired

Definition at line 7226 of file ScriptEngine.cpp.

◆ parseScriptAction()

void ScriptEngine::parseScriptAction ( INI * ini )

static

Parse script action entry. The InternalName has to match the action's internal name, and then it overrides the ui name and help text. If no entry is present in the ini file, the default code initialized value in ScriptEngine::init() is used. jba

Definition at line 378 of file ScriptEngine.cpp.

◆ parseScriptCondition()

void ScriptEngine::parseScriptCondition ( INI * ini )

static

Parse script condition entry. The InternalName has to match the condition's internal name, and then it overrides the ui name and help text. If no entry is present in the ini file, the default code initialized value in ScriptEngine::init() is used. jba

Definition at line 413 of file ScriptEngine.cpp.

◆ particleEditorUpdate()

void ScriptEngine::particleEditorUpdate ( void )

protected

Updates the particle editor if its present

Definition at line 8280 of file ScriptEngine.cpp.

◆ pauseTimer()

void ScriptEngine::pauseTimer ( ScriptAction * pAction )

protected

Stops a timer.

Definition at line 6767 of file ScriptEngine.cpp.

◆ removeAllSequentialScripts() [1/2]

void ScriptEngine::removeAllSequentialScripts ( Object * obj )

Definition at line 7781 of file ScriptEngine.cpp.

◆ removeAllSequentialScripts() [2/2]

void ScriptEngine::removeAllSequentialScripts ( Team * team )

Definition at line 7803 of file ScriptEngine.cpp.

◆ removeNamedMapReveal()

void ScriptEngine::removeNamedMapReveal ( const AsciiString & revealName )

Definition at line 6256 of file ScriptEngine.cpp.

◆ removeObjectFromCache()

void ScriptEngine::removeObjectFromCache ( Object * pDeadObject )

virtual

removes a dead object from the cache, to prevent "Bad Stuff"(r)

Definition at line 7138 of file ScriptEngine.cpp.

◆ removeObjectTypes()

void ScriptEngine::removeObjectTypes ( ObjectTypes * typesToRemove )

protected

Removes an object types list from the list owned by the script engine, and then deletes the associated item.

Definition at line 6695 of file ScriptEngine.cpp.

◆ removeSequentialScript()

void ScriptEngine::removeSequentialScript ( SequentialScript * scriptToRemove )

Definition at line 7776 of file ScriptEngine.cpp.

◆ reset()

void ScriptEngine::reset ( void )

virtual

Reset.

Reset

Implements SubsystemInterface.

Definition at line 5276 of file ScriptEngine.cpp.

◆ restartTimer()

void ScriptEngine::restartTimer ( ScriptAction * pAction )

protected

Restarts a timer.

Definition at line 6781 of file ScriptEngine.cpp.

◆ runObjectScript()

void ScriptEngine::runObjectScript	(	const AsciiString &	scriptName,
		Object *	pThisObject = NULL )

virtual

Runs a script attached to this object.

runScript - Executes a subroutine script, or script group - tests conditions, and executes actions or false actions.

Definition at line 6088 of file ScriptEngine.cpp.

◆ runScript()

void ScriptEngine::runScript	(	const AsciiString &	scriptName,
		Team *	pThisTeam = NULL )

virtual

Runs a script.

runScript - Executes a subroutine script, or script group - tests conditions, and executes actions or false actions.

Definition at line 6032 of file ScriptEngine.cpp.

◆ setChooseVictimAlwaysUsesNormal()

void ScriptEngine::setChooseVictimAlwaysUsesNormal ( Bool receive )

inline

Definition at line 263 of file ScriptEngine.h.

◆ setCounter()

void ScriptEngine::setCounter ( ScriptAction * pAction )

protected

Sets a counter.

Definition at line 6363 of file ScriptEngine.cpp.

◆ setCurrentTrackName()

void ScriptEngine::setCurrentTrackName ( AsciiString a )

inline

Definition at line 333 of file ScriptEngine.h.

◆ setEnableVTune()

void ScriptEngine::setEnableVTune ( Bool value )

Begin VTUNE.

Definition at line 8119 of file ScriptEngine.cpp.

◆ setFade()

void ScriptEngine::setFade ( ScriptAction * pAction )

protected

Sets a fade.

Definition at line 6378 of file ScriptEngine.cpp.

◆ setFlag()

void ScriptEngine::setFlag ( ScriptAction * pAction )

protected

Sets a flag

Definition at line 6490 of file ScriptEngine.cpp.

◆ setGlobalDifficulty()

void ScriptEngine::setGlobalDifficulty ( GameDifficulty difficulty )

Definition at line 8820 of file ScriptEngine.cpp.

◆ setObjectCount()

void ScriptEngine::setObjectCount	(	Int	playerIndex,
		const AsciiString &	objectTypeName,
		Int	newCount )

Definition at line 6683 of file ScriptEngine.cpp.

◆ setObjectsShouldReceiveDifficultyBonus()

void ScriptEngine::setObjectsShouldReceiveDifficultyBonus ( Bool receive )

inline

Definition at line 260 of file ScriptEngine.h.

◆ setPriorityDefault()

void ScriptEngine::setPriorityDefault ( ScriptAction * pAction )

protected

Sets an Attack Priority Set default value.

Definition at line 6653 of file ScriptEngine.cpp.

◆ setPriorityKind()

void ScriptEngine::setPriorityKind ( ScriptAction * pAction )

protected

Sets an Attack Priority Set value for all things of a particular kind.

Definition at line 6629 of file ScriptEngine.cpp.

◆ setPriorityThing()

void ScriptEngine::setPriorityThing ( ScriptAction * pAction )

protected

Sets an Attack Priority Set value for a thing

Definition at line 6553 of file ScriptEngine.cpp.

◆ setSequentialTimer() [1/2]

void ScriptEngine::setSequentialTimer	(	Object *	obj,
		Int	frameCount )

Definition at line 7840 of file ScriptEngine.cpp.

◆ setSequentialTimer() [2/2]

void ScriptEngine::setSequentialTimer	(	Team *	team,
		Int	frameCount )

Definition at line 7862 of file ScriptEngine.cpp.

◆ setSway()

void ScriptEngine::setSway ( ScriptAction * pAction )

protected

Sets a counter.

Definition at line 6412 of file ScriptEngine.cpp.

◆ setTimer()

void ScriptEngine::setTimer	(	ScriptAction *	pAction,
		Bool	millisecondTimer,
		Bool	random )

protected

Starts a timer.

Definition at line 6738 of file ScriptEngine.cpp.

◆ setToppleDirection()

void ScriptEngine::setToppleDirection	(	const AsciiString &	objectName,
		const Coord3D *	direction )

if the object has a specified topple direction, change it to direction. Otherwise add it to the /** list.

Definition at line 7515 of file ScriptEngine.cpp.

◆ signalUIInteract()

void ScriptEngine::signalUIInteract ( const AsciiString & hookName )

virtual

Notify that a UI button was pressed and some flag should go true, for one frame only.

Definition at line 7266 of file ScriptEngine.cpp.

◆ startCloseWindowTimer()

void ScriptEngine::startCloseWindowTimer ( void )

virtual

Starts the timer to close windows after a mission is won or lost.

startCloseWindowTimer

Definition at line 5720 of file ScriptEngine.cpp.

◆ startEndGameTimer()

void ScriptEngine::startEndGameTimer ( void )

virtual

Starts the end game timer after a mission is won or lost.

startEndGameTimer

Definition at line 5712 of file ScriptEngine.cpp.

◆ startQuickEndGameTimer()

void ScriptEngine::startQuickEndGameTimer ( void )

virtual

Starts the quick end game timer after a campaign is won or lost.

startQuickEndGameTimer

Definition at line 5704 of file ScriptEngine.cpp.

◆ subCounter()

void ScriptEngine::subCounter ( ScriptAction * pAction )

protected

Subtracts from a counter.

Definition at line 6446 of file ScriptEngine.cpp.

◆ transferObjectName()

void ScriptEngine::transferObjectName	(	const AsciiString &	unitName,
		Object *	pNewObject )

virtual

Kris: Looks for existing cached object with same name and replaces that object point with the supplied one. This is an important feature for units that change into something else. Good examples include terrorists entering a vehicle to convert it to a carbomb, pilots adding veterancy to vehicles, hijackers stealing vehicles, and infantry taking over disabled vehicles.

Definition at line 7156 of file ScriptEngine.cpp.

◆ turnBreezeOff()

void ScriptEngine::turnBreezeOff ( void )

inline

Definition at line 313 of file ScriptEngine.h.

◆ undoNamedMapReveal()

void ScriptEngine::undoNamedMapReveal ( const AsciiString & revealName )

Definition at line 6223 of file ScriptEngine.cpp.

◆ update()

void ScriptEngine::update ( void )

virtual

Update.

Update

Implements SubsystemInterface.

Definition at line 5503 of file ScriptEngine.cpp.

◆ updateFades()

void ScriptEngine::updateFades ( void )

protected

updateFades

Definition at line 5728 of file ScriptEngine.cpp.

◆ xfer()

void ScriptEngine::xfer ( Xfer * xfer )

protectedvirtual

Xfer method Version Info: 1: Initial version 2: Added m_namedReveals and m_allObjectTypeLists (CBD) 3: Added m_objectsShouldReceiveDifficultyBonus (JKMCD) 4: current music track info 5: add ChooseVictimAlwaysUsesNormal

Implements Snapshot.

Definition at line 8836 of file ScriptEngine.cpp.

Member Data Documentation

◆ m_acquiredSciences

ScienceVec ScriptEngine::m_acquiredSciences[MAX_PLAYER_COUNT]

protected

Definition at line 476 of file ScriptEngine.h.

◆ m_actionTemplates

ActionTemplate ScriptEngine::m_actionTemplates[ScriptAction::NUM_ITEMS]

protected

Definition at line 432 of file ScriptEngine.h.

◆ m_allObjectTypeLists

AllObjectTypes ScriptEngine::m_allObjectTypeLists

protected

Definition at line 486 of file ScriptEngine.h.

◆ m_attackPriorityInfo

AttackPriorityInfo ScriptEngine::m_attackPriorityInfo[MAX_ATTACK_PRIORITIES]

protected

Definition at line 438 of file ScriptEngine.h.

◆ m_breezeInfo

BreezeInfo ScriptEngine::m_breezeInfo

protected

Definition at line 482 of file ScriptEngine.h.

◆ m_callingObject

Object* ScriptEngine::m_callingObject

protected

Object that is calling script, used for THIS_OBJECT.

Definition at line 443 of file ScriptEngine.h.

◆ m_callingTeam

Team* ScriptEngine::m_callingTeam

protected

Team that is calling script, used for THIS_TEAM.

Definition at line 442 of file ScriptEngine.h.

◆ m_ChooseVictimAlwaysUsesNormal

Bool ScriptEngine::m_ChooseVictimAlwaysUsesNormal

protected

Definition at line 488 of file ScriptEngine.h.

◆ m_closeWindowTimer

Int ScriptEngine::m_closeWindowTimer

protected

Definition at line 441 of file ScriptEngine.h.

◆ m_completedUpgrades

ListAsciiStringObjectID ScriptEngine::m_completedUpgrades[MAX_PLAYER_COUNT]

protected

Definition at line 475 of file ScriptEngine.h.

◆ m_completedVideo

ListAsciiString ScriptEngine::m_completedVideo

protected

These are three separate lists rather than one to increase speed efficiency.

Definition at line 466 of file ScriptEngine.h.

◆ m_conditionObject

Object* ScriptEngine::m_conditionObject

protected

Unit that is being used to evaluate conditions, used for THIS_OBJECT.

Definition at line 445 of file ScriptEngine.h.

◆ m_conditionTeam

Team* ScriptEngine::m_conditionTeam

protected

Team that is being used to evaluate conditions, used for THIS_TEAM.

Definition at line 444 of file ScriptEngine.h.

◆ m_conditionTemplates

ConditionTemplate ScriptEngine::m_conditionTemplates[Condition::NUM_ITEMS]

protected

Definition at line 433 of file ScriptEngine.h.

◆ m_counters

TCounter ScriptEngine::m_counters[MAX_COUNTERS]

protected

Definition at line 434 of file ScriptEngine.h.

◆ m_curFadeFrame

Int ScriptEngine::m_curFadeFrame

protected

Definition at line 456 of file ScriptEngine.h.

◆ m_curFadeValue

Real ScriptEngine::m_curFadeValue

protected

Definition at line 455 of file ScriptEngine.h.

◆ m_currentPlayer

Player* ScriptEngine::m_currentPlayer

protected

Definition at line 448 of file ScriptEngine.h.

◆ m_currentTrackName

AsciiString ScriptEngine::m_currentTrackName

protected

Definition at line 450 of file ScriptEngine.h.

◆ m_endGameTimer

Int ScriptEngine::m_endGameTimer

protected

Definition at line 440 of file ScriptEngine.h.

◆ m_fade

TFade ScriptEngine::m_fade

protected

Definition at line 452 of file ScriptEngine.h.

◆ m_fadeFramesDecrease

Int ScriptEngine::m_fadeFramesDecrease

protected

Definition at line 459 of file ScriptEngine.h.

◆ m_fadeFramesHold

Int ScriptEngine::m_fadeFramesHold

protected

Definition at line 458 of file ScriptEngine.h.

◆ m_fadeFramesIncrease

Int ScriptEngine::m_fadeFramesIncrease

protected

Definition at line 457 of file ScriptEngine.h.

◆ m_finishedSpecialPowers

ListAsciiStringObjectID ScriptEngine::m_finishedSpecialPowers[MAX_PLAYER_COUNT]

protected

Definition at line 474 of file ScriptEngine.h.

◆ m_firstUpdate

Bool ScriptEngine::m_firstUpdate

protected

Definition at line 447 of file ScriptEngine.h.

◆ m_flags

TFlag ScriptEngine::m_flags[MAX_FLAGS]

protected

Definition at line 436 of file ScriptEngine.h.

◆ m_frameObjectCountChanged

UnsignedInt ScriptEngine::m_frameObjectCountChanged

protected

Definition at line 461 of file ScriptEngine.h.

◆ m_freezeByScript

Bool ScriptEngine::m_freezeByScript

protected

Definition at line 485 of file ScriptEngine.h.

◆ m_gameDifficulty

GameDifficulty ScriptEngine::m_gameDifficulty

protected

Definition at line 483 of file ScriptEngine.h.

◆ m_maxFade

Real ScriptEngine::m_maxFade

protected

Definition at line 454 of file ScriptEngine.h.

◆ m_midwaySpecialPowers

ListAsciiStringObjectID ScriptEngine::m_midwaySpecialPowers[MAX_PLAYER_COUNT]

protected

Definition at line 473 of file ScriptEngine.h.

◆ m_minFade

Real ScriptEngine::m_minFade

protected

Definition at line 453 of file ScriptEngine.h.

◆ m_namedObjects

VecNamedRequests ScriptEngine::m_namedObjects

protected

Definition at line 446 of file ScriptEngine.h.

◆ m_namedReveals

VecNamedReveal ScriptEngine::m_namedReveals

protected

Definition at line 480 of file ScriptEngine.h.

◆ m_numAttackInfo

Int ScriptEngine::m_numAttackInfo

protected

Definition at line 439 of file ScriptEngine.h.

◆ m_numCounters

Int ScriptEngine::m_numCounters

protected

Definition at line 435 of file ScriptEngine.h.

◆ m_numFlags

Int ScriptEngine::m_numFlags

protected

Definition at line 437 of file ScriptEngine.h.

◆ m_objectCounts

ObjectTypeCount ScriptEngine::m_objectCounts[MAX_PLAYER_COUNT]

protected

Definition at line 463 of file ScriptEngine.h.

◆ m_objectsShouldReceiveDifficultyBonus

Bool ScriptEngine::m_objectsShouldReceiveDifficultyBonus

protected

Definition at line 487 of file ScriptEngine.h.

◆ m_sequentialScripts

VecSequentialScriptPtr ScriptEngine::m_sequentialScripts

protected

Definition at line 420 of file ScriptEngine.h.

◆ m_shownMPLocalDefeatWindow

Bool ScriptEngine::m_shownMPLocalDefeatWindow

protected

Definition at line 490 of file ScriptEngine.h.

◆ m_skirmishHumanPlayer

Player* ScriptEngine::m_skirmishHumanPlayer

protected

Definition at line 449 of file ScriptEngine.h.

◆ m_testingAudio

ListAsciiStringUINT ScriptEngine::m_testingAudio

protected

Definition at line 468 of file ScriptEngine.h.

◆ m_testingSpeech

ListAsciiStringUINT ScriptEngine::m_testingSpeech

protected

Definition at line 467 of file ScriptEngine.h.

◆ m_toppleDirections

ListAsciiStringCoord3D ScriptEngine::m_toppleDirections

protected

Definition at line 478 of file ScriptEngine.h.

◆ m_triggeredSpecialPowers

ListAsciiStringObjectID ScriptEngine::m_triggeredSpecialPowers[MAX_PLAYER_COUNT]

protected

Definition at line 472 of file ScriptEngine.h.

◆ m_uiInteractions

ListAsciiString ScriptEngine::m_uiInteractions

protected

Definition at line 470 of file ScriptEngine.h.

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

Code/GameEngine/Include/GameLogic/ScriptEngine.h
Code/GameEngine/Source/GameLogic/ScriptEngine/ScriptEngine.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ VecSequentialScriptPtr

◆ VecSequentialScriptPtrIt

Member Enumeration Documentation

◆ anonymous enum

◆ TFade

Constructor & Destructor Documentation

◆ ScriptEngine()

◆ ~ScriptEngine()

Member Function Documentation

◆ addActionTemplateInfo()

◆ addConditionTemplateInfo()

◆ addCounter()

◆ addObjectToCache()

◆ AdjustDebugVariableData()

◆ adjustTimer()

◆ adjustToppleDirection() [1/2]

◆ adjustToppleDirection() [2/2]

◆ allocateCounter()

◆ allocateFlag()

◆ AppendDebugMessage()

◆ appendSequentialScript()

◆ callSubroutine()

◆ checkConditionsForTeamNames()

◆ cleanupSequentialScript()

◆ clearFlag()

◆ clearTeamFlags()

◆ crc()

◆ createNamedCache()

◆ createNamedMapReveal()

◆ debugVictory()

◆ didUnitExist()

◆ disableScript()

◆ doFreezeTime()

◆ doNamedMapReveal()

◆ doObjectTypeListMaintenance()

◆ doUnfreezeTime()

◆ enableScript()

◆ evaluateAndProgressAllSequentialScripts()

◆ evaluateCondition()

◆ evaluateConditions()

◆ evaluateCounter()

◆ evaluateFlag()

◆ evaluateTimer()

◆ executeActions()

◆ executeScript()

◆ executeScripts()

◆ findAttackInfo()

◆ findGroup()

◆ findScript()

◆ findScriptByName()

◆ forceUnfreezeTime()

◆ friend_executeAction()

◆ getActionTemplate()

◆ getAttackInfo()

◆ getBreezeInfo()

◆ getChooseVictimAlwaysUsesNormal()

◆ getConditionTemplate()

◆ getCounter()

◆ getCurrentPlayer()

◆ getCurrentTrackName()

◆ getDefaultAttackInfo()

◆ getEnableVTune()

◆ getFade()

◆ getFadeValue()

◆ getFrameObjectCountChanged()

◆ getGlobalDifficulty()

◆ getObjectCount()

◆ getObjectsShouldReceiveDifficultyBonus()

◆ getObjectTypes()

◆ getPlayerFromAsciiString()

◆ getQualifiedTriggerAreaByName()

◆ getSkirmishEnemyPlayer()