Doors - Revision history

Frost Salamander: /* Automatically Removing Keys from Player Inventory After Use */

2025-11-08T11:16:15Z

Automatically Removing Keys from Player Inventory After Use

← Older revision		Revision as of 11:16, 8 November 2025
Line 279:		Line 279:
	====Automatically Removing Keys from Player Inventory After Use====		====Automatically Removing Keys from Player Inventory After Use====
	If a fan mission has a lot of keys it can clog up the player inventory. If the key is single-use, it can be useful to automatically remove it from the player inventory after use. Below is a way to do it using a simple setup and a generic script function that can be used for multiple doors.		If a fan mission has a lot of keys it can clog up the player inventory. If the key is single-use, it can be useful to automatically remove it from the player inventory after use. Below is a way to do it using a simple setup and a generic script function that can be used for multiple doors.

			If you want to avoid scripting, see the [[Doors#Simpler,_No-script_Version\|simpler, no-script version]].

	=====Generic Version=====		=====Generic Version=====
Line 321:		Line 323:
	'''The script:'''		'''The script:'''
	* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.		* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.
	* Any door can use this script as ~~its~~ generic, although they will need their own trigger_count entities. In theory they could share the same target_callscriptfunction entity, but that might become inconvenient - up to the mapper.		* Any door can use this script as it's generic, although they will need their own trigger_count entities. In theory they could share the same target_callscriptfunction entity, but that might become inconvenient - up to the mapper.

	=====Simpler, No-script Version=====		=====Simpler, No-script Version=====

Frost Salamander: /* Generic Version */

2025-11-06T20:23:32Z

Generic Version

← Older revision		Revision as of 20:23, 6 November 2025
Line 321:		Line 321:
	'''The script:'''		'''The script:'''
	* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.		* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.
	* Any door can use this script as its generic (although they will need their own trigger_count entities. In theory they could share the same target_callscriptfunction entity, but that might become inconvenient - up to the mapper.		* Any door can use this script as its generic, although they will need their own trigger_count entities. In theory they could share the same target_callscriptfunction entity, but that might become inconvenient - up to the mapper.

	=====Simpler, No-script Version=====		=====Simpler, No-script Version=====

Frost Salamander: /* Generic Version */

2025-11-06T20:23:00Z

Generic Version

← Older revision		Revision as of 20:23, 6 November 2025
Line 321:		Line 321:
	'''The script:'''		'''The script:'''
	* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.		* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.
	* Any door can use this script as its generic (although they will need their own trigger_count ~~and~~ target_callscriptfunction ~~entities)~~		* Any door can use this script as its generic (although they will need their own trigger_count entities. In theory they could share the same target_callscriptfunction entity, but that might become inconvenient - up to the mapper.

	=====Simpler, No-script Version=====		=====Simpler, No-script Version=====

Frost Salamander: /* Simpler, No-script Version */

2025-11-06T20:05:41Z

Simpler, No-script Version

← Older revision		Revision as of 20:05, 6 November 2025
Line 324:		Line 324:

	=====Simpler, No-script Version=====		=====Simpler, No-script Version=====
	This is similar to above, but is more limited. You need to hard-code the key name as a spawnarg on an atdm:target_itemremove entity as ~~they~~ key name can't be automatically determined. This makes it slightly more error-prone as we're naming entities in more than one place, but ideal if you're uncomfortable with scripting.		This is similar to above, but is more limited. You need to hard-code the key name as a spawnarg on an atdm:target_itemremove entity as the key name can't be automatically determined like in the above script. This makes it slightly more error-prone as we're naming entities in more than one place, but ideal if you're uncomfortable with scripting.

	[[File:Key remove4.png\|left\|thumb]]		[[File:Key remove4.png\|left\|thumb]]

Frost Salamander at 20:05, 6 November 2025

2025-11-06T20:05:08Z

← Older revision		Revision as of 20:05, 6 November 2025
Line 326:		Line 326:
	This is similar to above, but is more limited. You need to hard-code the key name as a spawnarg on an atdm:target_itemremove entity as they key name can't be automatically determined. This makes it slightly more error-prone as we're naming entities in more than one place, but ideal if you're uncomfortable with scripting.		This is similar to above, but is more limited. You need to hard-code the key name as a spawnarg on an atdm:target_itemremove entity as they key name can't be automatically determined. This makes it slightly more error-prone as we're naming entities in more than one place, but ideal if you're uncomfortable with scripting.

	[[File:Key ~~remove3~~.png\|left\|thumb]]		[[File:Key remove4.png\|left\|thumb]]
	<div style="clear: both"></div>		<div style="clear: both"></div>

Frost Salamander: /* Automatically Removing Keys from Player Inventory After Use */

2025-11-06T20:03:01Z

Automatically Removing Keys from Player Inventory After Use

← Older revision		Revision as of 20:03, 6 November 2025
Line 278:		Line 278:

	====Automatically Removing Keys from Player Inventory After Use====		====Automatically Removing Keys from Player Inventory After Use====
			If a fan mission has a lot of keys it can clog up the player inventory. If the key is single-use, it can be useful to automatically remove it from the player inventory after use. Below is a way to do it using a simple setup and a generic script function that can be used for multiple doors.

			=====Generic Version=====

	If a fan mission has a lot of keys it can clog up the player inventory. If the key is single-use, it can be useful to automatically remove it from the player inventory after use. Below is a way to do it using a simple setup and a generic script function that can be used for multiple doors.
	You'll need the following entities, preferably set up near each other in your map:		You'll need the following entities, preferably set up near each other in your map:
	* The door entity itself		* The door entity itself
Line 320:		Line 322:
	* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.		* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.
	* Any door can use this script as its generic (although they will need their own trigger_count and target_callscriptfunction entities)		* Any door can use this script as its generic (although they will need their own trigger_count and target_callscriptfunction entities)

			=====Simpler, No-script Version=====
			This is similar to above, but is more limited. You need to hard-code the key name as a spawnarg on an atdm:target_itemremove entity as they key name can't be automatically determined. This makes it slightly more error-prone as we're naming entities in more than one place, but ideal if you're uncomfortable with scripting.

			[[File:Key remove3.png\|left\|thumb]]
			<div style="clear: both"></div>

			Explanation as follows:

			'''atdm:target_itemremove entity:'''
			* '''unique_item ''' spawnarg: The name of the key to remove from the player inventory

	===Lockpicks===		===Lockpicks===

Frost Salamander: /* Automatically Removing Keys from Player Inventory After Use */

2025-11-06T19:47:06Z

Automatically Removing Keys from Player Inventory After Use

← Older revision		Revision as of 19:47, 6 November 2025
Line 314:		Line 314:
	'''atdm:target_callscriptfunction entity:'''		'''atdm:target_callscriptfunction entity:'''
	* '''call''' spawnarg: This is the name of the script function to call		* '''call''' spawnarg: This is the name of the script function to call
	* '''foreach''' spawnarg: This version of the script event provides access to 'activator', or the entity that triggered it (in this case, the door). Using that information we can obtain the key name. See [[A to Z Scripting: Ways of calling a script#target_callscriptfunction\|here]] for details.		* '''foreach''' spawnarg: This version of the script event provides access to the 'activator', or the entity that triggered it (in this case, the door). Using that information we can obtain the key name. See [[A to Z Scripting: Ways of calling a script#target_callscriptfunction\|here]] for details.
	* '''target any static entity''': For this version of the script event to work, the target_callscriptfunction entity needs to target something. This can be any static entity in the map (i.e. one that won't get removed or anything). I usually just target the nearest entity (e.g. a light or a lamp, or a model). This provides no functionality in the context of this tutorial, it just satisfies the conditions of the script event.		* '''target any static entity''': For this version of the script event to work, the target_callscriptfunction entity needs to target something. This can be any static entity in the map (i.e. one that won't get removed or anything). I usually just target the nearest entity (e.g. a light or a lamp, or a model). This provides no functionality in the context of this tutorial, it just satisfies the conditions of the script event.

Frost Salamander: /* Automatically Removing Keys from Player Inventory After Use */

2025-11-06T19:44:21Z

Automatically Removing Keys from Player Inventory After Use

← Older revision		Revision as of 19:44, 6 November 2025
Line 284:		Line 284:
	* A trigger_count entity		* A trigger_count entity
	* An atdm:target_callscriptfunction entity		* An atdm:target_callscriptfunction entity
			* some random entity for the target_callscriptfunction to target (explanation below)

	The below diagram shows the spawnargs and targeting required for the setup:		The below diagram shows the spawnargs and targeting required for the setup:

Frost Salamander: /* Keys */

2025-11-06T19:42:34Z

Keys

← Older revision		Revision as of 19:42, 6 November 2025
Line 276:		Line 276:

	By default, ALL locks can be opened by any key named ''key_master''. Just create a key in your map, name it ''key_master'' and it becomes a master key for use while testing. Add inv_map_start 1 to it so it is in the player inventory at game start. Remember to delete it when your mission is finished.		By default, ALL locks can be opened by any key named ''key_master''. Just create a key in your map, name it ''key_master'' and it becomes a master key for use while testing. Add inv_map_start 1 to it so it is in the player inventory at game start. Remember to delete it when your mission is finished.

			====Automatically Removing Keys from Player Inventory After Use====

			If a fan mission has a lot of keys it can clog up the player inventory. If the key is single-use, it can be useful to automatically remove it from the player inventory after use. Below is a way to do it using a simple setup and a generic script function that can be used for multiple doors.
			You'll need the following entities, preferably set up near each other in your map:
			* The door entity itself
			* A trigger_count entity
			* An atdm:target_callscriptfunction entity

			The below diagram shows the spawnargs and targeting required for the setup:
			[[File:Key remove2.png\|left\|thumb]]

			<div style="clear: both"></div>
			The script being called ('openDoor') is defined in fms/<mapname>/maps/<mapname>.script and looks like this:

			void openDoor(entity target, entity door, entity callscriptfunction)
			{
			string keyName = door.getKey("used_by");
			entity key = sys.getEntity(keyName);
			$player1.replaceInvItem(key, $null_entity);
			}

			Explanation as follows:

			'''For the door:'''
			* '''trigger_on_open''' spawnarg: The door is configured to trigger its targets when it opens
			* target '''trigger_count''' entity: this is the entity that is triggered when the door is opened
			* '''used_by''' spawnarg: This names the key entity required for unlocking the door
			* The other spawnargs are just the usual for setting the door as locked and unpickable

			'''trigger_count entity:'''
			* When triggered, this entity will in turn trigger the script that removes the key from the player inventory.
			* '''count''' spawnarg: This is set to 1 because we only want the key removal script called once - the first time the player opens the door.
			* this entity targets the atdm:target_callscriptfunction, which contains details of the script to execute

			'''atdm:target_callscriptfunction entity:'''
			* '''call''' spawnarg: This is the name of the script function to call
			* '''foreach''' spawnarg: This version of the script event provides access to 'activator', or the entity that triggered it (in this case, the door). Using that information we can obtain the key name. See [[A to Z Scripting: Ways of calling a script#target_callscriptfunction\|here]] for details.
			* '''target any static entity''': For this version of the script event to work, the target_callscriptfunction entity needs to target something. This can be any static entity in the map (i.e. one that won't get removed or anything). I usually just target the nearest entity (e.g. a light or a lamp, or a model). This provides no functionality in the context of this tutorial, it just satisfies the conditions of the script event.

			'''The script:'''
			* Pretty self-explanatory. The script gets the name of the key entity via the '''used_by''' spawnarg on the door, retrieves the key entity, and then replaces it in the player inventory with a null entity, effectively removing it.
			* Any door can use this script as its generic (although they will need their own trigger_count and target_callscriptfunction entities)

	===Lockpicks===		===Lockpicks===

Frost Salamander: /* AI Door management */

2024-01-30T20:12:20Z

AI Door management

← Older revision		Revision as of 20:12, 30 January 2024
Line 609:		Line 609:

	;"canRemainOpen" :If set to 1, it's the same as "ai_should_not_close, with the added behavior that this is ignored if the door needs to be relocked, or the door is marked "shouldBeClosed". '''(This spawnarg is available starting in TDM 2.02.)'''		;"canRemainOpen" :If set to 1, it's the same as "ai_should_not_close, with the added behavior that this is ignored if the door needs to be relocked, or the door is marked "shouldBeClosed". '''(This spawnarg is available starting in TDM 2.02.)'''


	Spawnargs '''on the AI''' that the mapper can use:		Spawnargs '''on the AI''' that the mapper can use: