A to Z Scripting: Scripting with... - Revision history

Datiswous: /* GUIs */

2025-09-14T22:22:31Z

GUIs

← Older revision		Revision as of 22:22, 14 September 2025
Line 138:		Line 138:

	== GUIs ==		== GUIs ==
	GUIs use a different, in some ways more limited scripting system. You can find a detailed explanation of them on [https://~~www~~.~~iddevnet~~.com/~~doom3/guis.html iddev~~.~~net~~].		GUIs use a different, in some ways more limited scripting system. You can find a detailed explanation of them on [https://wiki.thedarkmod.com/index.php?title=GUI_Scripting_Language GUI_Scripting_Language].

	== Next / previous article ==		== Next / previous article ==

Dragofer: Correct crouch flag

2021-11-28T11:01:52Z

Correct crouch flag

← Older revision		Revision as of 11:01, 28 November 2021
Line 37:		Line 37:
	Then you can use the flags like this:		Then you can use the flags like this:
	if ((!guard.AI_KNOCKEDOUT) && (!guard.AI_DEAD)) guard.bark("snd_conversation"); //if the ai is neither KO nor dead, make him bark a line for a (monologue) conversation		if ((!guard.AI_KNOCKEDOUT) && (!guard.AI_DEAD)) guard.bark("snd_conversation"); //if the ai is neither KO nor dead, make him bark a line for a (monologue) conversation
	if (player_self.~~AI_CROUCHING~~) //check if the player is crouching		if (player_self.AI_CROUCH) //check if the player is crouching

Dragofer: Couple indents

2021-11-13T13:37:49Z

Couple indents

← Older revision		Revision as of 13:37, 13 November 2021
Line 49:		Line 49:
	boolean AI_CROUCH; //AI is inspecting a corpse, or the player is crouched		boolean AI_CROUCH; //AI is inspecting a corpse, or the player is crouched
	boolean AI_RUN; //AI is running		boolean AI_RUN; //AI is running
	float AI_AlertIndex; //goes from 0-5, 0 means completely idle and 5 is in combat. Derived from AlertLevel.		float AI_AlertIndex; //goes from 0-5, 0 means completely idle and 5 is in combat. Derived from AlertLevel.
	float AI_AlertLevel; //goes from 0-23, increases when the AI notices suspicious things and decays with time.		float AI_AlertLevel; //goes from 0-23, increases when the AI notices suspicious things and decays with time.

Dragofer at 12:11, 29 December 2020

2020-12-29T12:11:22Z

← Older revision		Revision as of 12:11, 29 December 2020
Line 136:		Line 136:
	== Cutscenes ==		== Cutscenes ==
	Grayman has written an excellent tutorial series on making ingame cutscenes here: [[Cutscenes]].		Grayman has written an excellent tutorial series on making ingame cutscenes here: [[Cutscenes]].

			== GUIs ==
			GUIs use a different, in some ways more limited scripting system. You can find a detailed explanation of them on [https://www.iddevnet.com/doom3/guis.html iddev.net].

	== Next / previous article ==		== Next / previous article ==

Dragofer at 12:07, 29 December 2020

2020-12-29T12:07:45Z

@@ Line 132: / Line 132: @@
 == Inventory items ==
-Inventory items are entities that have moved into the inventory. They retain their entity name whenever the player picks them up or drops them. An exception is stackable items: whenever a player picks up a stackable item, it only increases the "inv_count" of the entity the player already has in his inventory. Dropping the items produces identical copies of the entity, so stackable items lose any individual properties they might have had.
+A detailed article on creating inventory items and scripting with them can be found here: [[Inventory]]
 == Cutscenes ==

Dragofer: /* Calling scripts by using inv items on in-world entities */

2020-12-29T11:26:11Z

Calling scripts by using inv items on in-world entities

← Older revision		Revision as of 11:26, 29 December 2020
Line 160:		Line 160:
	1. Pressing the "use" key with the inventory item selected and the in-world entity frob-highlighted.		1. Pressing the "use" key with the inventory item selected and the in-world entity frob-highlighted.
	The "use" key is typically bound to "enter" or "u". The most basic way of setting this up is with these spawnargs on the in-world entity, more differentiated setups can be found at [[Tool, Key, custom used by inventory actions]]:		The "use" key is typically bound to "enter" or "u". The most basic way of setting this up is with these spawnargs on the in-world entity, more differentiated setups can be found at [[Tool, Key, custom used by inventory actions]]:
			//on the in-world entity
	"use_action_script" "name_of_script"		"use_action_script" "name_of_script"
	"used_by" "name_of_inventory_item"		"used_by" "name_of_inventory_item"

			//on the inventory item
			"usable" "1"


	~~The inventory item will need the spawnarg "usable" "1".~~ Note that the player can hold down the "use" key, calling the script every frame, so you might want to make the script single-use, i.e. by defining a global variable to keep track of whether the script has already been called:		Note that the player can hold down the "use" key, calling the script every frame, so you might want to make the script single-use, i.e. by defining a global variable to keep track of whether the script has already been called:

	boolean has_been_called;		boolean has_been_called;
Line 176:		Line 181:


	Or ~~disallow~~ further calls of the script until it's finished:		Or prevent further calls of the script until it's finished:

	boolean in_use;		boolean in_use;

Dragofer: /* Calling scripts by using inv items on in-world entities */

2020-12-29T11:24:36Z

Calling scripts by using inv items on in-world entities

← Older revision		Revision as of 11:24, 29 December 2020
Line 169:		Line 169:
	void name_of_script()		void name_of_script()
	{		{
	if(has_been_called) return;		if(has_been_called) return;
	else has_been_called = true;		else has_been_called = true;

	... rest of script		... rest of script
Line 179:		Line 179:

	boolean in_use;		boolean in_use;

	void activate_loudspeaker(entity ent_loudspeaker)		void activate_loudspeaker(entity ent_loudspeaker)
	{		{

Dragofer: /* Inventory items */

2020-12-29T11:23:55Z

Inventory items

← Older revision		Revision as of 11:23, 29 December 2020
Line 166:		Line 166:

	boolean has_been_called;		boolean has_been_called;

	void name_of_script()		void name_of_script()
	{		{
	if(!has_been_called) has_been_called = true;		if(has_been_called) return;
	~~else return;~~		else has_been_called = true;

	... rest of script		... rest of script
	}		}


			Or disallow further calls of the script until it's finished:

			boolean in_use;

			void activate_loudspeaker(entity ent_loudspeaker)
			{
			if (in_use) return;
			else in_use = true;

			float sound_duration = ent_loudspeaker.startSound("snd_loudspeaker", SND_CHANNEL_ANY, false);

			sys.wait(sound_duration);
			in_use = false;
			}


Line 194:		Line 212:
	* The in-world entity should be set up to Respond to that stim by running the script.		* The in-world entity should be set up to Respond to that stim by running the script.

	You might also want to make sure that the player is still holding the item, unless you want to allow the player to throw the item at the in-world entity.		You might also want to make sure that the player is still holding the item with getGrabbed(), unless you want to allow the player to throw the item at the in-world entity.

	(Note that this might be incompatible with the above example script's use of an entity input, "entity ent_world", since S/R might not pass an entity name.)		(Note that this might be incompatible with the above example script's use of an entity input, "entity ent_world", since S/R might not pass an entity name.)

Dragofer: /* Calling scripts by using inv items on in-world entities */

2020-12-29T11:14:01Z

Calling scripts by using inv items on in-world entities

← Older revision		Revision as of 11:14, 29 December 2020
Line 162:		Line 162:
	"use_action_script" "name_of_script"		"use_action_script" "name_of_script"
	"used_by" "name_of_inventory_item"		"used_by" "name_of_inventory_item"

			The inventory item will need the spawnarg "usable" "1". Note that the player can hold down the "use" key, calling the script every frame, so you might want to make the script single-use, i.e. by defining a global variable to keep track of whether the script has already been called:

			boolean has_been_called;
			void name_of_script()
			{
			if(!has_been_called) has_been_called = true;
			else return;
			... rest of script
			}


	2. Frobbing the in-world entity with the inventory item selected.		2. Frobbing the in-world entity with the inventory item selected.
Line 182:		Line 193:
	* The moveable inventory item should be set up to emit a Stim, ideally a custom stim type, to its surroundings.		* The moveable inventory item should be set up to emit a Stim, ideally a custom stim type, to its surroundings.
	* The in-world entity should be set up to Respond to that stim by running the script.		* The in-world entity should be set up to Respond to that stim by running the script.

			You might also want to make sure that the player is still holding the item, unless you want to allow the player to throw the item at the in-world entity.

	(Note that this might be incompatible with the above example script's use of an entity input, "entity ent_world", since S/R might not pass an entity name.)		(Note that this might be incompatible with the above example script's use of an entity input, "entity ent_world", since S/R might not pass an entity name.)


	== Cutscenes ==		== Cutscenes ==

Dragofer at 10:11, 29 December 2020

2020-12-29T10:11:12Z

← Older revision		Revision as of 10:11, 29 December 2020
Line 134:		Line 134:
	Inventory items are entities that have moved into the inventory. They retain their entity name whenever the player picks them up or drops them. An exception is stackable items: whenever a player picks up a stackable item, it only increases the "inv_count" of the entity the player already has in his inventory. Dropping the items produces identical copies of the entity, so stackable items lose any individual properties they might have had.		Inventory items are entities that have moved into the inventory. They retain their entity name whenever the player picks them up or drops them. An exception is stackable items: whenever a player picks up a stackable item, it only increases the "inv_count" of the entity the player already has in his inventory. Dropping the items produces identical copies of the entity, so stackable items lose any individual properties they might have had.

	Note that ~~you can refer to~~ inventory ~~items by either of their~~ 2 names:		Note that each inventory item has 2 names:
	# The entity name, which only the mapper sees and is unique in the map, i.e. atdm_key_simple_1		# The entity name, which only the mapper sees and is unique in the map, i.e. atdm_key_simple_1
	# The inventory item name, which is a string that's shown to the player and can be used by multiple entities, i.e. "Simple key"		# The inventory item name, which is a string that's shown to the player and can be used by multiple entities, i.e. "Simple key"

			You can use the entity name directly in script events, while the inventory item name is only useful when checking which inventory item the player currently has selected.

	Alternatively you can work with the item's category, i.e. "Keys" or "Moulds".		Alternatively you can work with the item's category, i.e. "Keys" or "Moulds".


			=== Removing items ===
			There's no script event explicitly for removing an inventory item. Instead, you need to replace an inventory item with $null_entity as follows:

			$player1.replaceInvItem($key_simple_1, $null_entity);



Line 145:		Line 154:
	# Pressing the "use" key with the inventory item selected and the in-world entity frob-highlighted.		# Pressing the "use" key with the inventory item selected and the in-world entity frob-highlighted.
	# Frobbing the in-world entity with the inventory item selected.		# Frobbing the in-world entity with the inventory item selected.
	# For moveables: holding the inventory item in front of the in-world entity~~. This requires stim/response to work~~.		# For moveables: holding the inventory item in front of the in-world entity.

	You should therefore cover all the possible situations when writing a script that should be called by presenting an inventory item to an in-world entity.		You should therefore cover all the possible situations when writing a script that should be called by presenting an inventory item to an in-world entity.

	1. Pressing the "use" key with the inventory item selected and the in-world entity frob-highlighted.		1. Pressing the "use" key with the inventory item selected and the in-world entity frob-highlighted.
	The "use" key is typically bound to "enter" or "u". The most basic way of setting this up is with these spawnargs on the in-world entity:		The "use" key is typically bound to "enter" or "u". The most basic way of setting this up is with these spawnargs on the in-world entity, more differentiated setups can be found at [[Tool, Key, custom used by inventory actions]]:
	"use_action_script" "name_of_script"		"use_action_script" "name_of_script"
	"used_by" "name_of_inventory_item"		"used_by" "name_of_inventory_item"
Line 161:		Line 170:
	The script will then need to check whether the player has the correct type of inventory item selected. It's convenient to get the "used_by" spawnarg for this:		The script will then need to check whether the player has the correct type of inventory item selected. It's convenient to get the "used_by" spawnarg for this:
	void name_of_script(entity ent_inworld)		void name_of_script(entity ent_inworld)
	if ( $player1.getCurInvItemEntity() ==		{
			if ( $player1.getCurInvItemEntity() == ent_inworld.getEntityKey("used_by")
			{
			sys.println("Player has used the correct inventory item");
			}
			}


			3. For moveables: holding the inventory item in front of the in-world entity.
			This is suitable for the Stim/Response system:
			* The moveable inventory item should be set up to emit a Stim, ideally a custom stim type, to its surroundings.
			* The in-world entity should be set up to Respond to that stim by running the script.

			(Note that this might be incompatible with the above example script's use of an entity input, "entity ent_world", since S/R might not pass an entity name.)


			== Cutscenes ==
			Grayman has written an excellent tutorial series on making ingame cutscenes here: [[Cutscenes]].

	== Next / previous article ==		== Next / previous article ==