Scripting basics - Revision history

Geep: /* The sys entity */ Change how to kill the player

2023-05-23T18:00:48Z

The sys entity: Change how to kill the player

← Older revision		Revision as of 18:00, 23 May 2023
Line 101:		Line 101:
	=== The sys entity ===		=== The sys entity ===
	Script events always have to be called on an entity, like this:		Script events always have to be called on an entity, like this:
	$player1.~~kill~~(); // kill the player		$player1.setHealth(0); // to kill the player, use this instead of trying $player1.kill();
	However, there are a lot of script events which are unrelated to a specific entity, like cos(), sin(), spawn() and such. These "generic" events are invoked on the '''sys''' entity, like this:		However, there are a lot of script events which are unrelated to a specific entity, like cos(), sin(), spawn() and such. These "generic" events are invoked on the '''sys''' entity, like this:
	entity myLight = sys.spawn("light_moving"); // spawn a new light entity		entity myLight = sys.spawn("light_moving"); // spawn a new light entity

Datiswous: /* Script Events */ changed link to latest TDM_Script_Reference

2022-02-10T10:27:00Z

Script Events: changed link to latest TDM_Script_Reference

← Older revision		Revision as of 10:27, 10 February 2022
Line 118:		Line 118:
	* scripts/tdm_events.script		* scripts/tdm_events.script

	[[TDM_Script_Reference~~/2.06~~\|Latest Script Events]]		[[TDM_Script_Reference\|Latest Script Events]]

	== Discovery (or, why is TDM ignoring my script file?) ==		== Discovery (or, why is TDM ignoring my script file?) ==

Datiswous: /* Discovery (or, why is TDM ignoring my script file?) */ typo

2022-02-10T10:21:05Z

Discovery (or, why is TDM ignoring my script file?): typo

← Older revision		Revision as of 10:21, 10 February 2022
Line 122:		Line 122:
	== Discovery (or, why is TDM ignoring my script file?) ==		== Discovery (or, why is TDM ignoring my script file?) ==

	TDM will automatically find and load some kinds of files, such as .def files. However, it does not do the same for script files; if you merely create a .script file and place it in the <tt>script</tt> directory, it will be ~~not~~ loaded.		TDM will automatically find and load some kinds of files, such as .def files. However, it does not do the same for script files; if you merely create a .script file and place it in the <tt>script</tt> directory, it will not be loaded.

	There are two ways to use a script:		There are two ways to use a script:

Nbohr1more: /* Script Events */

2019-02-28T08:35:27Z

Script Events

← Older revision		Revision as of 08:35, 28 February 2019
Line 112:		Line 112:
	'''Q. What are some common or useful script events for editing?'''		'''Q. What are some common or useful script events for editing?'''

	'''A.''' A list of all Doom3 and TDM script events are listed in two files (open with a text editor): scripts/doom_events.script, scripts/tdm_events.script. Proper syntax for the Doom3 events is here [~~http~~://~~www~~.~~modwiki~~.~~net/wiki~~/Script_events_~~%28Doom_3%29~~]. Note that TDM has some of its own script events, like setFrobable (in the tdm_events.script list). A quick list of common or useful script events good for editing is here: [[Script_Events_User-Friendly_List]], with syntax and description, and including TDM events. It doesn't list all script events and all details, just common & useful ones for actual mapping IMO.		'''A.''' A list of all Doom3 and TDM script events are listed in two files (open with a text editor): scripts/doom_events.script, scripts/tdm_events.script. Proper syntax for the Doom3 events is here [https://modwiki.dhewm3.org/Script_events_(Doom_3)]. Note that TDM has some of its own script events, like setFrobable (in the tdm_events.script list). A quick list of common or useful script events good for editing is here: [[Script_Events_User-Friendly_List]], with syntax and description, and including TDM events. It doesn't list all script events and all details, just common & useful ones for actual mapping IMO.

	You can find a list of existing script events in the following file:		You can find a list of existing script events in the following file:

Nbohr1more: /* Script Events */

2019-02-28T08:29:05Z

Script Events

← Older revision		Revision as of 08:29, 28 February 2019
Line 117:		Line 117:

	* scripts/tdm_events.script		* scripts/tdm_events.script

			[[TDM_Script_Reference/2.06\|Latest Script Events]]

	== Discovery (or, why is TDM ignoring my script file?) ==		== Discovery (or, why is TDM ignoring my script file?) ==

Nbohr1more: /* Interfacing with the SDK */

2019-02-28T08:26:34Z

Interfacing with the SDK

← Older revision		Revision as of 08:26, 28 February 2019
Line 170:		Line 170:
	'''TODO:''' Describe the various ways in which the SDK can interface with Doom 3 scripts: scriptevents, scriptvars (instances of idScriptVar), etc.		'''TODO:''' Describe the various ways in which the SDK can interface with Doom 3 scripts: scriptevents, scriptvars (instances of idScriptVar), etc.

	Vanilla Doom 3 script reference: https://modwiki.~~xnet~~.fi/Script_events_~~%28Doom_3%29~~		Vanilla Doom 3 script reference: https://modwiki.dhewm3.org/Script_events_(Doom_3)

	Also need refs for Dark Mod's scriptevents.		Also need refs for Dark Mod's scriptevents.

Nbohr1more: /* Syntax */

2019-02-27T08:19:41Z

Syntax

← Older revision		Revision as of 08:19, 27 February 2019
Line 19:		Line 19:
	Note the complete lack of a dedicated integer type (use <tt>float</tt> instead), or any ability to define complex data structures! If data structures are needed, they are typically created in the SDK and ''scriptevents'' (see below) are provided to allow scripts to manipulate them.		Note the complete lack of a dedicated integer type (use <tt>float</tt> instead), or any ability to define complex data structures! If data structures are needed, they are typically created in the SDK and ''scriptevents'' (see below) are provided to allow scripts to manipulate them.

	For a more detailed specification of the script syntax, see [https://modwiki.~~xnet~~.fi/SCRIPT_~~%28file_format%29~~ Modwiki's SCRIPT file reference].		For a more detailed specification of the script syntax, see [https://modwiki.dhewm3.org/SCRIPT_(file_format) Modwiki's SCRIPT file reference].

	=== The float data type ===		=== The float data type ===

Grayman: /* Interfacing with the SDK */

2017-04-02T23:05:09Z

Interfacing with the SDK

← Older revision		Revision as of 23:05, 2 April 2017
Line 168:		Line 168:
	No language can operate usefully in a vacuum - at some point it needs to go out and do stuff.		No language can operate usefully in a vacuum - at some point it needs to go out and do stuff.

	'''TODO:''' Describe the various ways in which the SDK can interface with Doom 3 scripts; scriptevents, scriptvars (instances of idScriptVar), etc.		'''TODO:''' Describe the various ways in which the SDK can interface with Doom 3 scripts: scriptevents, scriptvars (instances of idScriptVar), etc.

	Vanilla Doom 3 script reference: https://modwiki.xnet.fi/Script_events_%28Doom_3%29		Vanilla Doom 3 script reference: https://modwiki.xnet.fi/Script_events_%28Doom_3%29

	Also need refs for Dark Mod's scriptevents.		Also need refs for Dark Mod's scriptevents.

			== Thread Use ==

			When TDM is run in Debug mode, the order of a thread routine's definition and its use is important. If a thread routine is used before it's defined, a crash can occur.

			Be sure to follow the following format when calling a thread:


			void RoutineName(); // initial declaration

			...

			object::RoutineName() {}; // routine definition

			...

			thread RoutineName(); // use

	== Things that don't exist in scripting ==		== Things that don't exist in scripting ==

Tels: add link to script objects

2014-10-03T11:07:17Z

add link to script objects

← Older revision		Revision as of 11:07, 3 October 2014
Line 70:		Line 70:
	There also exists a NULL entity, named '''$null_entity'''. It can be used to compare an entity to NULL, to see if it points to a valid entity. Some script events return NULL to signal "no such entity exists".		There also exists a NULL entity, named '''$null_entity'''. It can be used to compare an entity to NULL, to see if it points to a valid entity. Some script events return NULL to signal "no such entity exists".

	==== ~~event tpyes~~ from ~~script objects~~ ====		==== Entity types from Script Objects ====

	If you declare a script object with:		If you declare a [[Script objects\|script object]] with:

	<pre>		<pre>
Line 191:		Line 191:

	* [[My first map script]]		* [[My first map script]]
			* [[Script objects]]

	{{scripting}}		{{scripting}}
	{{todo}}		{{todo}}

Tels: add more info

2014-10-03T11:04:26Z

add more info

← Older revision		Revision as of 11:04, 3 October 2014
Line 42:		Line 42:
	The data type vector implements a three-component vector. As arrays and their native operator [] is not implemented in D3 scripting, the elements of vectors are accessed like this:		The data type vector implements a three-component vector. As arrays and their native operator [] is not implemented in D3 scripting, the elements of vectors are accessed like this:
	vector myVec; // declare a new vector		vector myVec; // declare a new vector
	myVec_x = 20;		myVec_x = 20; // access only the X part of the vector
	myVec_y = 0;		myVec_y = 0; // access only the Y part
	myVec_z = 0;		myVec_z = 0; // access only the Z part
	// myVec now holds the 3D vector <20,0,0>		// myVec now holds the 3D vector <20,0,0>
	Alternatively, you can assign a string to a vector variable, like this (the string gets converted correctly, but be sure to use '''single quotes'''):		Alternatively, you can assign a string to a vector variable, like this (the string gets converted correctly, but be sure to use '''single quotes'''):
	myVec = '0 10 0';		myVec = '0 10 0';
	As an example, the '''getOrigin()''' methods return a vector.		As an example, the '''getOrigin()''' methods return a vector.

			You can compare vectors by using the 'X Y Z' syntax:

			<pre>
			vector myv = '1 0 0';
			if (myv == '1 0 0')
			{
			// do something
			}
			</pre>

	=== The entity data type ===		=== The entity data type ===
Line 54:		Line 64:
	entity myEnt; // declare myEnt to be of type entity		entity myEnt; // declare myEnt to be of type entity
	myEnt = $player1; // Let myEnt refer to the player entity, which by convention has the name "player1".		myEnt = $player1; // Let myEnt refer to the player entity, which by convention has the name "player1".
	The entity data type can be compared to the pointers (that's also how they are stored internally) ~~- there~~ also exists a NULL entity, named '''$null_entity'''.		The entity data type can be compared to the pointers (that's also how they are stored internally).

			==== The NULL entity ====

			There also exists a NULL entity, named '''$null_entity'''. It can be used to compare an entity to NULL, to see if it points to a valid entity. Some script events return NULL to signal "no such entity exists".

			==== event tpyes from script objects ====

			If you declare a script object with:

			<pre>
			object my_entity_type
			{
			float getMyCount();
			};

			my_entity_type::getMyCount()
			{
			return 2;
			}
			</pre>

			you can then later declare variables to be of that type. This is important to call methods on these entities, as otherwise your own defined methods are not accessible:

			<pre>
			entity my_name;
			my_name.getMyCount(); // error, normal entities do not have a script event getMyCount

			my_entity_type my_name_2;
			my_name_2.getMyCount(); // works

			my_entity_type my_name_3 = my_name; // casts from "entity" to "my_entity_type"
			my_name_3.getMyCount(); // works
			</pre>

	=== The sys entity ===		=== The sys entity ===
	Script events always have to be called on an entity, like this:		Script events always have to be called on an entity, like this:
	$player1.kill(); // kill the player		$player1.kill(); // kill the player
	However, there are a lot of ~~scriptEvents~~ which are unrelated to a specific entity, like cos(), sin(), spawn() and such. These "generic" events are invoked on the '''sys''' entity, like this:		However, there are a lot of script events which are unrelated to a specific entity, like cos(), sin(), spawn() and such. These "generic" events are invoked on the '''sys''' entity, like this:
	entity myLight = sys.spawn("light_moving"); // spawn a new light entity		entity myLight = sys.spawn("light_moving"); // spawn a new light entity
	myLight.setOrigin($player1.getOrigin()); // move it to the point where the player is currently residing		myLight.setOrigin($player1.getOrigin()); // move it to the point where the player is currently residing
Line 65:		Line 108:
	=== Script Events ===		=== Script Events ===

	A script event is a pre-made ~~object~~ that does something for you, usually to some game item you specify, just when you write it in your code (like $item.eventX(); does X to item). Sometimes it wants parameters or arguments to run (the stuff in parentheses) and will give an error if you don't put the arguments in the parentheses in exactly the way it wants, with the right number of them & right data types, etc. And some of them return values too, especially the "get" functions, which are handed over to a variable (e.g., X = getValue();, now X has the value. If X is an entity, you can even act on X as if it's the entity itself. Just be sure the data type of X and Value are the same, e.g. float, or string, or entity, etc, or you'll get an error).		A script event is a pre-made function that does something for you, usually to some game item you specify, just when you write it in your code (like $item.eventX(); does X to item). Sometimes it wants parameters or arguments to run (the stuff in parentheses) and will give an error if you don't put the arguments in the parentheses in exactly the way it wants, with the right number of them & right data types, etc. And some of them return values too, especially the "get" functions, which are handed over to a variable (e.g., X = getValue();, now X has the value. If X is an entity, you can even act on X as if it's the entity itself. Just be sure the data type of X and Value are the same, e.g. float, or string, or entity, etc, or you'll get an error).

	'''Q. What are some common or useful script events for editing?'''		'''Q. What are some common or useful script events for editing?'''