TDM Script Reference/2.02 - Revision history

SteveL: This was the draft page pre-2.02 release. Making it into a redirect while 2.02 is current.

2014-07-15T16:50:21Z

This was the draft page pre-2.02 release. Making it into a redirect while 2.02 is current.

SteveL: /* scriptEvent void setObjectiveState(float ObjNum, float State); */ minor fix in line with rev 6024

2014-05-31T20:16:57Z

scriptEvent void setObjectiveState(float ObjNum, float State);: minor fix in line with rev 6024

← Older revision		Revision as of 20:16, 31 May 2014
Line 6,726:		Line 6,726:
	:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);		:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
	::''ObjNum'': Starts counting at 1		::''ObjNum'': Starts counting at 1
	~~::''State'': Starts counting at 1~~

	==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====		==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

SteveL: /* scriptEvent void setObjectiveState(float ObjNum, float State); */ minor fix in line with rev 6024

2014-05-31T20:16:28Z

scriptEvent void setObjectiveState(float ObjNum, float State);: minor fix in line with rev 6024

← Older revision		Revision as of 20:16, 31 May 2014
Line 3,134:		Line 3,134:
	:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);		:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
	::''ObjNum'': Starts counting at 1		::''ObjNum'': Starts counting at 1
	~~::''State'': Starts counting at 1~~

	:Spawnclasses responding to this event: ''idPlayer''		:Spawnclasses responding to this event: ''idPlayer''

	==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====		==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

SteveL: Replacing header link to talk page

2014-05-31T19:51:01Z

Replacing header link to talk page

← Older revision		Revision as of 19:51, 31 May 2014
Line 1:		Line 1:
	This page has been generated automatically by the tdm_gen_script_event_doc console command.		This page has been generated automatically by the tdm_gen_script_event_doc console command, with [[Talk:TDM_Script_Reference/2.02\|manual amendments]].

	Generated by The Dark Mod 2.02, code revision 6021, last update: 2014-05-31 20:41		Generated by The Dark Mod 2.02, code revision 6021, last update: 2014-05-31 20:41

SteveL: /* idThread */ rem dup header after last amend

2014-05-31T19:47:20Z

idThread: rem dup header after last amend

← Older revision		Revision as of 19:47, 31 May 2014
Line 6,995:		Line 6,995:

	:Returns the entity of the main ambient light.		:Returns the entity of the main ambient light.

	~~==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====~~

	==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====		==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

SteveL: /* scriptEvent float getMissionStatistic(string statisticName); */ retabulating

2014-05-31T19:46:25Z

scriptEvent float getMissionStatistic(string statisticName);: retabulating

@@ Line 6,995: / Line 6,995: @@
 :Returns the entity of the main ambient light.
 ==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====
 :Returns current mission statistic.
-::''statisticName'': Can be one of (case insensitive): 	gamePlayTime: gameplay time in seconds 	damageDealt: damage dealt to enemies 	damageReceived: damage received by player 	healthReceived: health received by player 	pocketsPicked: pockets picked by player 	foundLoot: loot found by player 	missionLoot: total loot available in mission 	totalTimePlayerSeen: total time the player was seen by enemies in seconds. Updates only when AI lose sight of player 	numberTimesPlayerSeen: number of times player was seen by enemies 	numberTimesAISuspicious: number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score. 	numberTimesAISearched: number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score. 	sightingScore: sighting score (number of times player was seen * weight) 	stealthScore: stealth score (sighting score + alerts * weights) 	killedByPlayer: number of enemies killed by player 	knockedOutByPlayer: number of enemies knocked out by player 	bodiesFound: number of times enemies have spotted a body
+::''statisticName'': Can be one of (case insensitive):
 ==== scriptEvent float '''getPersistantFloat'''(string key); ====

SteveL: /* scriptEvent float getMissionStatistic(string statisticName); */ retabulating

2014-05-31T19:45:55Z

scriptEvent float getMissionStatistic(string statisticName);: retabulating

@@ Line 1,480: / Line 1,480: @@
 :Returns current mission statistic.
-::''statisticName'': Can be one of (case insensitive): 	gamePlayTime: gameplay time in seconds 	damageDealt: damage dealt to enemies 	damageReceived: damage received by player 	healthReceived: health received by player 	pocketsPicked: pockets picked by player 	foundLoot: loot found by player 	missionLoot: total loot available in mission 	totalTimePlayerSeen: total time the player was seen by enemies in seconds. Updates only when AI lose sight of player 	numberTimesPlayerSeen: number of times player was seen by enemies 	numberTimesAISuspicious: number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score. 	numberTimesAISearched: number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score. 	sightingScore: sighting score (number of times player was seen * weight) 	stealthScore: stealth score (sighting score + alerts * weights) 	killedByPlayer: number of enemies killed by player 	knockedOutByPlayer: number of enemies knocked out by player 	bodiesFound: number of times enemies have spotted a body
+::''statisticName'': Can be one of (case insensitive):
 :Spawnclasses responding to this event: ''idThread''
 ==== scriptEvent float '''getMouseGesture'''(); ====

SteveL: Changes for #3740

2014-05-31T19:42:16Z

Changes for #3740

Show changes

SteveL: consistent capitalization

2014-05-11T16:12:16Z

consistent capitalization

← Older revision		Revision as of 16:12, 11 May 2014
Line 9:		Line 9:
	= TDM Script Event Reference =		= TDM Script Event Reference =

	== All ~~events~~ ==		== All Events ==
	=== Alphabetic List === <!-- Trying out TOC fix. This repetition is necessary for the toclimit to work. We can't skip a heading level -->		=== Alphabetic List === <!-- Trying out TOC fix. This repetition is necessary for the toclimit to work. We can't skip a heading level -->
	==== scriptEvent void '''accelSound'''(string sound); ====		==== scriptEvent void '''accelSound'''(string sound); ====

SteveL: /* Alphabetic List */ Making header less repetitive

2014-05-11T16:10:57Z

Alphabetic List: Making header less repetitive

← Older revision		Revision as of 16:10, 11 May 2014
Line 9:		Line 9:
	= TDM Script Event Reference =		= TDM Script Event Reference =

	== ~~Alphabetic List~~ ==		== All events ==
	=== Alphabetic List === <!-- Trying out TOC fix. This repetition is necessary for the toclimit to work. We can't skip a heading level -->		=== Alphabetic List === <!-- Trying out TOC fix. This repetition is necessary for the toclimit to work. We can't skip a heading level -->
	==== scriptEvent void '''accelSound'''(string sound); ====		==== scriptEvent void '''accelSound'''(string sound); ====