Script objects - Revision history

Datiswous: changed size of titles/subtitles so it's more clear what belongs to what

2026-02-24T19:42:52Z

changed size of titles/subtitles so it's more clear what belongs to what

← Older revision		Revision as of 19:42, 24 February 2026
Line 1:		Line 1:
	== Introduction ==		== <big>Introduction</big> ==

	A '''script object''' is an object that is written in the idTech4 scripting language, and an be attached to arbitrary entities. Each entity can have '''only one''' script object, but one script object can be attached to multiple entities.		A '''script object''' is an object that is written in the idTech4 scripting language, and an be attached to arbitrary entities. Each entity can have '''only one''' script object, but one script object can be attached to multiple entities.
Line 5:		Line 5:
	To use a script object on an entity, give it the spawnarg '''scriptobject''' set to the name of the script object. For your convience, TDM already contains a few useful script objects, here is a list:		To use a script object on an entity, give it the spawnarg '''scriptobject''' set to the name of the script object. For your convience, TDM already contains a few useful script objects, here is a list:

	== List of script objects ==		== <big>List of script objects</big> ==


	=== tdm_alarm ===		=== <big>tdm_alarm</big> ===

	A script object that sounds an alarm sound that can be heard by AI as suspicious sound, as well as a player audible sound.		A script object that sounds an alarm sound that can be heard by AI as suspicious sound, as well as a player audible sound.
Line 20:		Line 20:


	=== tdm_suicide ===		=== <big>tdm_suicide</big> ===

	<pre>		<pre>
Line 32:		Line 32:


	=== tdm_light_holder ===		=== <big>tdm_light_holder</big> ===

	<pre>		<pre>
Line 45:		Line 45:
	(See also the light_ext and light_moving_ext scriptobjects, used by extinguishable light sources to respond to fire/water/gas stims.)		(See also the light_ext and light_moving_ext scriptobjects, used by extinguishable light sources to respond to fire/water/gas stims.)

	=== tdm_gui_message ===		=== <big>tdm_gui_message</big> ===

	This script object is attached to an '''atdm:gui_message''' entity, and the entity shows a message to the player, based on cvars and spawnargs. You can use this script object for the "popup" messages that appear on the upper left corner (f.i. to give the player hints) or for screeen overlays like in a movie, where it says f.i. "Random Town, past midnight". Where the message appears and how it looks is entirely customizable by using a different gui.		This script object is attached to an '''atdm:gui_message''' entity, and the entity shows a message to the player, based on cvars and spawnargs. You can use this script object for the "popup" messages that appear on the upper left corner (f.i. to give the player hints) or for screeen overlays like in a movie, where it says f.i. "Random Town, past midnight". Where the message appears and how it looks is entirely customizable by using a different gui.
Line 73:		Line 73:


	=== tdm_voice ===		=== <big>tdm_voice</big> ===

	A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for voiceovers and narrator effects. These effects use separate volumes defined by two different CVARs.		A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for voiceovers and narrator effects. These effects use separate volumes defined by two different CVARs.
Line 105:		Line 105:
	* Spawnarg: "snd_say_female" "female_sound_you_want_to_play" // overrides snd_say if the player is female		* Spawnarg: "snd_say_female" "female_sound_you_want_to_play" // overrides snd_say if the player is female

	== See also ==		== <big>See also</big> ==

	* [[Writing script objects]]		* [[Writing script objects]]

	{{scripting}}		{{scripting}}

VanishedOne: /* tdm_light_holder */ From what I can see, only STIM_TRIGGER is actually processed by tdm_light_holder

2019-09-09T17:04:09Z

tdm_light_holder: From what I can see, only STIM_TRIGGER is actually processed by tdm_light_holder

← Older revision		Revision as of 17:04, 9 September 2019
Line 41:		Line 41:
	This is typical attached to either lights (an electrical lamp f.i.) or light holders (a candle holder with attached candle + flame, or a torch with attached flame). This script object has handy methods to toggle all lights that this holder has, regardless how many (multiple flames?) or where (flame on holder or flame on candle on holder?).		This is typical attached to either lights (an electrical lamp f.i.) or light holders (a candle holder with attached candle + flame, or a torch with attached flame). This script object has handy methods to toggle all lights that this holder has, regardless how many (multiple flames?) or where (flame on holder or flame on candle on holder?).

	This script object also makes the entity react to ~~stims (f.i. fire, water and gas), and/or~~ triggers like when you link a button/lever/trigger to this entity.		This script object also makes the entity react to triggers like when you link a button/lever/trigger to this entity.

			(See also the light_ext and light_moving_ext scriptobjects, used by extinguishable light sources to respond to fire/water/gas stims.)

	=== tdm_gui_message ===		=== tdm_gui_message ===

Grayman: /* tdm_voice */

2015-10-25T01:34:51Z

tdm_voice

← Older revision		Revision as of 01:34, 25 October 2015
Line 78:		Line 78:
	How to use:		How to use:

	# Place an '''atdm:voice''' entity in your map (location does not matter, and you need only one)		# Place an '''atdm:voice''' entity (in '''Sound''' folder) in your map (location does not matter, and you need only one)
	# Place multiple '''atdm:voice_trigger''' entities in your map		# Place multiple '''atdm:voice_trigger''' entities (in '''Targets''' folder) in your map
	# Link your '''atdm:voice_trigger''' entities to your '''atdm:voice''' entity ({{key\|CTRL}}+{{key\|K}} in [[DarkRadiant]])		# Link your '''atdm:voice_trigger''' entities to your '''atdm:voice''' entity ({{key\|CTRL}}+{{key\|K}} in [[DarkRadiant]])

Grayman: /* tdm_voice */

2015-10-23T11:09:31Z

tdm_voice

← Older revision		Revision as of 11:09, 23 October 2015
Line 74:		Line 74:
	=== tdm_voice ===		=== tdm_voice ===

	A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for ~~voice overs~~ and narrator effects. ~~Both~~ effects use ~~the volume in~~ two different CVARs~~, so their volume can be controlled separately~~.		A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for voiceovers and narrator effects. These effects use separate volumes defined by two different CVARs.

	How to use:		How to use:
Line 80:		Line 80:
	# Place an '''atdm:voice''' entity in your map (location does not matter, and you need only one)		# Place an '''atdm:voice''' entity in your map (location does not matter, and you need only one)
	# Place multiple '''atdm:voice_trigger''' entities in your map		# Place multiple '''atdm:voice_trigger''' entities in your map
	# ~~link~~ your '''atdm:voice_trigger''' entities to '''~~your~~ atdm:voice''' entity ({{key\|CTRL}}+{{key\|K}} in [[DarkRadiant]])		# Link your '''atdm:voice_trigger''' entities to your '''atdm:voice''' entity ({{key\|CTRL}}+{{key\|K}} in [[DarkRadiant]])

	Give the following spawnargs to the '''atdm:voice_trigger''' entities:		Give the following spawnargs to the '''atdm:voice_trigger''' entities:
Line 87:		Line 87:
	"snd_say" "sound_you_want_to_play" // generic, male or female		"snd_say" "sound_you_want_to_play" // generic, male or female
	"as_player" "1" // if the player should say things		"as_player" "1" // if the player should say things
	"as_player" "0" // if the ~~speaker (from off)~~ should say things		"as_player" "0" // if the narrator should say things
	</pre>		</pre>

	~~The difference between~~ "as_player" ~~"0" and~~ "1" is the ~~volume as set~~ in the menu.		When "as_player" is set to "1", the sound volume is controlled by the "Player Voice Volume" slider in the TDM Audio menu.

			When "as_player" is set to "0", the sound volume is controlled by the "Narrator Volume" slider in the TDM Audio menu.
	==== CVARS ====		==== CVARS ====

	* tdm_voice_player_volume		* tdm_voice_player_volume // Player Voice Volume
	* tdm_voice_from_off_volume		* tdm_voice_from_off_volume // Narrator Volume
	* Menu settings		* Menu settings

Tels: fix typos and the menu settings are now included

2014-08-13T18:36:43Z

fix typos and the menu settings are now included

← Older revision		Revision as of 18:36, 13 August 2014
Line 29:		Line 29:
	Note: In TDM v1.03 the delay '''must be''' >= 1, or the script will wait 360 seconds. In TDM v1.04, the time can also be between 0 and 1 second, for instance 0.5 seconds.		Note: In TDM v1.03 the delay '''must be''' >= 1, or the script will wait 360 seconds. In TDM v1.04, the time can also be between 0 and 1 second, for instance 0.5 seconds.

	Note #3: From TDM v1.04 onwards, any entity with this script object will activate its targets right before it removes itself. This can be used to trigger things ~~ater~~ a certain time from map start has passed, and is used f.i. by the new "atdm:vanishing_platform" entity.		Note #3: From TDM v1.04 onwards, any entity with this script object will activate its targets right before it removes itself. This can be used to trigger things after a certain time from map start has passed, and is used f.i. by the new "atdm:vanishing_platform" entity.


Line 52:		Line 52:
	==== CVARs ====		==== CVARs ====

	* '''tdm_show_trainer_messages''' - if true, ~~the~~ messages are shown, if false, suppressed		* '''tdm_show_trainer_messages''' - if true, trainer messages are shown, if false, suppressed

	==== Spawnargs ====		==== Spawnargs ====
Line 74:		Line 74:
	=== tdm_voice ===		=== tdm_voice ===

	A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for voice overs and ~~speaker-from-off~~ effects. Both effects use the volume in two different CVARs, so their volume can be controlled separately.		A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for voice overs and narrator effects. Both effects use the volume in two different CVARs, so their volume can be controlled separately.

	How to use:		How to use:
Line 96:		Line 96:
	* tdm_voice_player_volume		* tdm_voice_player_volume
	* tdm_voice_from_off_volume		* tdm_voice_from_off_volume
			* Menu settings

	'''Unsupported''' options (taken out because the team doesn't want to add them):		'''Unsupported''' options (taken out because the team doesn't want to add them):
Line 101:		Line 102:
	* CVAR: tdm_player_is_female		* CVAR: tdm_player_is_female
	* Spawnarg: "snd_say_female" "female_sound_you_want_to_play" // overrides snd_say if the player is female		* Spawnarg: "snd_say_female" "female_sound_you_want_to_play" // overrides snd_say if the player is female
	* Menu settings (the sliders were taken out of the audio menu)

	== See also ==		== See also ==

SteveL: Spelling of spawnarg: script_object -> scriptobject

2014-02-06T07:02:12Z

Spelling of spawnarg: script_object -> scriptobject

← Older revision		Revision as of 07:02, 6 February 2014
Line 3:		Line 3:
	A '''script object''' is an object that is written in the idTech4 scripting language, and an be attached to arbitrary entities. Each entity can have '''only one''' script object, but one script object can be attached to multiple entities.		A '''script object''' is an object that is written in the idTech4 scripting language, and an be attached to arbitrary entities. Each entity can have '''only one''' script object, but one script object can be attached to multiple entities.

	To use a script object on an entity, give it the spawnarg '''~~script_object~~''' set to the name of the script object. For your convience, TDM already contains a few useful script objects, here is a list:		To use a script object on an entity, give it the spawnarg '''scriptobject''' set to the name of the script object. For your convience, TDM already contains a few useful script objects, here is a list:

	== List of script objects ==		== List of script objects ==
Line 23:		Line 23:

	<pre>		<pre>
	"~~script_object~~" "tdm_suicide"		"scriptobject" "tdm_suicide"
	"remove_delay" "100" // remove this entity 100 seconds after spawning it		"remove_delay" "100" // remove this entity 100 seconds after spawning it
	</pre>		</pre>
Line 35:		Line 35:

	<pre>		<pre>
	"~~script_object~~" "tdm_light_holder"		"scriptobject" "tdm_light_holder"
	"extinguished" "1" // the light starts off, but can be lit by the player		"extinguished" "1" // the light starts off, but can be lit by the player
	</pre>		</pre>

Tels: add link to full article and correct entity name

2012-02-15T21:39:53Z

add link to full article and correct entity name

← Older revision		Revision as of 21:39, 15 February 2012
Line 46:		Line 46:
	=== tdm_gui_message ===		=== tdm_gui_message ===

	This script object is attached to an atdm:~~target_message~~ entity, and the entity shows a message to the player, based on cvars and spawnargs. You can use this script object for the "popup" messages that appear on the upper left corner (f.i. to give the player hints) or for screeen overlays like in a movie, where it says f.i. "Random Town, past midnight". Where the message appears and how it looks is entirely customizable by using a different gui.		This script object is attached to an '''atdm:gui_message''' entity, and the entity shows a message to the player, based on cvars and spawnargs. You can use this script object for the "popup" messages that appear on the upper left corner (f.i. to give the player hints) or for screeen overlays like in a movie, where it says f.i. "Random Town, past midnight". Where the message appears and how it looks is entirely customizable by using a different gui.

			See [[Popup messages]] for more information.

	==== CVARs ====		==== CVARs ====

Tels: /* Spawnargs */

2012-02-15T19:32:09Z

Spawnargs

← Older revision		Revision as of 19:32, 15 February 2012
Line 58:		Line 58:
	* '''lines''' - Number of lines the text has		* '''lines''' - Number of lines the text has
	* '''text''' - The text to be shown on the message.		* '''text''' - The text to be shown on the message.
	* '''gui''' - Name of the GUI file, defaults to ''guis/~~message~~.gui''		* '''gui''' - Name of the GUI file, defaults to ''guis/tdm_message.gui''
	* '''wait''', '''delay''' - These two are inherited from '''atdm:target_callobjectfunction''' and set the "wait" between triggers and the initial "delay" before the messsage show.		* '''wait''', '''delay''' - These two are inherited from '''atdm:target_callobjectfunction''' and set the "wait" between triggers and the initial "delay" before the messsage show.
	* '''fade_out_time''' - Defaults to 1, in seconds. This time is waited for the GUI to fade out, then the message is forcefully removed. If you use a different gui with "gui", then set this spawnarg to match the fadeout time of your gui.		* '''fade_out_time''' - Defaults to 1, in seconds. This time is waited for the GUI to fade out, then the message is forcefully removed. If you use a different gui with "gui", then set this spawnarg to match the fadeout time of your gui.

Tels: tweak spacing

2011-03-20T09:55:17Z

tweak spacing

← Older revision		Revision as of 09:55, 20 March 2011
Line 30:		Line 30:

	Note #3: From TDM v1.04 onwards, any entity with this script object will activate its targets right before it removes itself. This can be used to trigger things ater a certain time from map start has passed, and is used f.i. by the new "atdm:vanishing_platform" entity.		Note #3: From TDM v1.04 onwards, any entity with this script object will activate its targets right before it removes itself. This can be used to trigger things ater a certain time from map start has passed, and is used f.i. by the new "atdm:vanishing_platform" entity.


	=== tdm_light_holder ===		=== tdm_light_holder ===

Tels: add tdm_alarm

2011-03-20T09:54:54Z

add tdm_alarm

← Older revision		Revision as of 09:54, 20 March 2011
Line 6:		Line 6:

	== List of script objects ==		== List of script objects ==


			=== tdm_alarm ===

			A script object that sounds an alarm sound that can be heard by AI as suspicious sound, as well as a player audible sound.

			Functions:

			void start_alarm();
			void stop_alarm();

			See [[atdm:alarm_sound]] on how to use it.