Teleporting entities - Revision history

Geep: Add new section Technique 3: "Kicking a Single Path Target Down the Road"

2024-10-10T20:49:38Z

Add new section Technique 3: "Kicking a Single Path Target Down the Road"

← Older revision		Revision as of 20:49, 10 October 2024
Line 107:		Line 107:
	add <name of desired path_corner>		add <name of desired path_corner>

	The AI initially has ~~with~~ no target path node set. After teleportation, arrange to trigger your target_changetarget to add the path_corner. This can be done various ways, e.g., by scripting or a trigger_once_entity.		The AI initially has no target path node set. After teleportation, arrange to trigger your target_changetarget to add the path_corner. This can be done various ways, e.g., by scripting or a trigger_once_entity.

			===Technique 3: "Kicking a Single Path Target Down the Road"===
			''Due to [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=497048 JackFarmer with testing by grodenglaive and thebigh, 2024]''

			Occasionally, for mysterious reasons (e.g., latent bugginess), patrolling AIs might quit patrolling, lie down, or show other undesired behavior. This is particularly problematic after teleporting. This third method seems more reliable to maintain proper patrolling.

			Instead of defining a static series of path nodes (or sub-series bridged by teleports), a single path entity "X" is placed at a starting location. The AI is given one target that always points to X... and then you arrange to teleport X to different locations. You just need to have the AI hit a trigger brush that triggers the teleport before it can reach the path corner. You can also teleport the AI at the same time (if desired to reach an inaccessible area for example) and they will continue walking to the path entity afterwords.

			===Visual and Sound Effects During Teleport===
			For how to give a teleporting wizard smoke puffs and sounds at teleport origin and destination, see [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=497016 this set of 2024 posts by thebigh and JackFarmer].


	{{editing}}		{{editing}}
	[[Category:AI]]		[[Category:AI]]
	[[Category:AI Tutorials]]		[[Category:AI Tutorials]]

Geep: Add AI templates

2021-12-14T19:03:30Z

Add AI templates

← Older revision		Revision as of 19:03, 14 December 2021
Line 110:		Line 110:

	{{editing}}		{{editing}}
			[[Category:AI]]
			[[Category:AI Tutorials]]

Geep: Add 'Making an AI Start a Path after Teleporting'

2021-12-14T18:47:38Z

Add 'Making an AI Start a Path after Teleporting'

@@ Line 11: / Line 11: @@
    vector east = '0 0 0'; // face east along the X axis in DR. Other directions: north = '0 90 0' (along the Y axis), west = '0 180 0', south = '0 270 0'.
    $player1.setViewAngles(east);
 TIP: If you need an invisible placemarker in your map as a teleport target, the Method 2 teleport entity discussed next is also ideal for that... an "off label" use.
@@ Line 80: / Line 75: @@
 ** Target a trigger_relay with brief delay from worldspawn
 ** Create a door (anywhere it can't be seen in the game), and give it auto_open_time 0.01
 {{editing}}

Geep: /* Method 1 - Traditional Scripting Approach */ add setViewAngle, use of teleport entity as placemarker

2021-03-31T01:07:49Z

Method 1 - Traditional Scripting Approach: add setViewAngle, use of teleport entity as placemarker

← Older revision		Revision as of 01:07, 31 March 2021
Line 3:		Line 3:
	== Method 1 - Traditional Scripting Approach ==		== Method 1 - Traditional Scripting Approach ==

	In Doom3 and ~~now~~ TDM, this is straightforward: set the origin and angles of the object inside a script and it will appear where it should. For instance, to teleport the player to, say, a rug called $new_place:		In Doom3 and likewise TDM, this is straightforward: set the origin and angles of the object inside a script and it will appear where it should. For instance, to teleport the player to, say, a rug called $new_place:

	$player1.setOrigin($new_place.getOrigin());		$player1.setOrigin($new_place.getOrigin()); // Does not affect the orientation

	Similarly, if you care about the ~~angle~~, there are setAngles() and getAngles() functions you can use.		Similarly, if you care about the orientation, there are general setAngles() and getAngles() functions you can use. Or the player-specific setViewAngles:

			vector east = '0 0 0'; // face east along the X axis in DR. Other directions: north = '0 90 0' (along the Y axis), west = '0 180 0', south = '0 270 0'.
			$player1.setViewAngles(east);

	Suppose you want to teleport an AI, and have it then begin a path. Create a path_waitfortrigger in your map as the start of that path, and target it from your AI. Then, your script might look like this:		Suppose you want to teleport an AI, and have it then begin a path. Create a path_waitfortrigger in your map as the start of that path, and target it from your AI. Then, your script might look like this:
Line 13:		Line 16:
	$myAI.setOrigin($new_place.getOrigin()); // teleport to near the path_waitfortrigger		$myAI.setOrigin($new_place.getOrigin()); // teleport to near the path_waitfortrigger
	sys.trigger($myAI); // proceed on from the waitfortrigger		sys.trigger($myAI); // proceed on from the waitfortrigger

			TIP: If you need an invisible placemarker in your map as a teleport target, the Method 2 teleport entity discussed next is also ideal for that... an "off label" use.

	== Method 2 - Using atdm:teleport ==		== Method 2 - Using atdm:teleport ==

Geep: /* Method 1 - Traditional Scripting Approach */ Add example of how to path after teleport

2021-01-25T06:44:33Z

Method 1 - Traditional Scripting Approach: Add example of how to path after teleport

← Older revision		Revision as of 06:44, 25 January 2021
Line 8:		Line 8:

	Similarly, if you care about the angle, there are setAngles() and getAngles() functions you can use.		Similarly, if you care about the angle, there are setAngles() and getAngles() functions you can use.

			Suppose you want to teleport an AI, and have it then begin a path. Create a path_waitfortrigger in your map as the start of that path, and target it from your AI. Then, your script might look like this:

			$myAI.setOrigin($new_place.getOrigin()); // teleport to near the path_waitfortrigger
			sys.trigger($myAI); // proceed on from the waitfortrigger

	== Method 2 - Using atdm:teleport ==		== Method 2 - Using atdm:teleport ==

Geep: A slight rewrite, mainly to clarify scripting and Stumpy's methods

2020-12-31T06:15:25Z

A slight rewrite, mainly to clarify scripting and Stumpy's methods

← Older revision		Revision as of 06:15, 31 December 2020
Line 1:		Line 1:
	Often you want to teleport one or more entities to a specific place and orientation~~. In Doom3, this is very easy, you need just to set the origin and angles of the object inside a script and it will appear where it should~~.		Often you want to teleport one or more entities to a specific place and orientation.

	~~However, to make this even easier and possible without writing scripts, a new '''atdm:teleport''' entity has been added.~~		== Method 1 - Traditional Scripting Approach ==

	== Basic ~~example~~ ==		In Doom3 and now TDM, this is straightforward: set the origin and angles of the object inside a script and it will appear where it should. For instance, to teleport the player to, say, a rug called $new_place:

			$player1.setOrigin($new_place.getOrigin());

			Similarly, if you care about the angle, there are setAngles() and getAngles() functions you can use.

			== Method 2 - Using atdm:teleport ==

			To make positioning easier and possible without writing scripts, a new '''atdm:teleport''' entity has been added.

			=== Basic Example ===

	* Create the atdm:teleport entity '''{{RMB}} -> Create Entity -> darkmod -> Targets -> atdm:teleport'''		* Create the atdm:teleport entity '''{{RMB}} -> Create Entity -> darkmod -> Targets -> atdm:teleport'''
Line 12:		Line 22:
	Note: Triggers have a lot of useful spawnargs that can insert delays, make it trigger only once etc.		Note: Triggers have a lot of useful spawnargs that can insert delays, make it trigger only once etc.

	=== Screenshot ===		==== Screenshot ====

	[[Image:Trigger teleport.jpg]]		[[Image:Trigger teleport.jpg]]

	== Teleporting multiple entities ==		=== Teleporting multiple entities ===

	To teleport more than one entity, you can target them all from the same teleport entity. The targets will be teleported in the order of the target spawnargs, e.g. "target0" first, "target1" second and so on.		To teleport more than one entity, you can target them all from the same teleport entity. The targets will be teleported in the order of the target spawnargs, e.g. "target0" first, "target1" second and so on.
Line 26:		Line 36:
	# '''teleport_offset''': Specifies an offset relative to the atdm:teleport entity		# '''teleport_offset''': Specifies an offset relative to the atdm:teleport entity
	# '''teleport_random_offset''': Specifies the magnitude of an random offset that will be added to the final location		# '''teleport_random_offset''': Specifies the magnitude of an random offset that will be added to the final location
			=
	=== Example: ===		==== Example: ====

	"teleport_offset" "-32 0 0" // 32 units to the left		"teleport_offset" "-32 0 0" // 32 units to the left
	"teleport_random_offset" "5 5 0" // -2.5 .. 2.5 units in X and Y direction from that		"teleport_random_offset" "5 5 0" // -2.5 .. 2.5 units in X and Y direction from that

	== Delays ==		=== Delays ===

	The '''atdm:teleport''' entity has two spawnargs that influence the time that the teleport happens:		The '''atdm:teleport''' entity has two spawnargs that influence the time that the teleport happens:
Line 39:		Line 49:
	# '''wait''' - the delay between each subsequent teleport		# '''wait''' - the delay between each subsequent teleport

	=== Example: ===		==== Example: ====

	"delay" "1"		"delay" "1"
Line 46:		Line 56:
	would wait 1 second before the first teleport, and then teleport the second entity 0.5 seconds later (after 1.5 seconds from triggering), the third 0.5 seconds later (so after 2 seconds after triggering) and so on.		would wait 1 second before the first teleport, and then teleport the second entity 0.5 seconds later (after 1.5 seconds from triggering), the third 0.5 seconds later (so after 2 seconds after triggering) and so on.

	== ~~Stumpy's Alternate~~ Method ==		== Method 3 - Using info_player_teleport ==
			As its name indicates, this alternate method, by Stumpy, is just for teleporting the player, not other entities. You create an info_player_teleport entity in your map (NOT an atdm:teleport NOR the func_teleport). The easiest way to find this is to click on the DR Entity Viewer left pane, then type "info_player_teleport"

			=== Example ===
	''Suppose at game start, you want to have the player's start position seem to differ by difficulty level. Simply start the player in a black room (probably any dark plain area will do), wait a moment for worldspawn to subside, then teleport.''		''Suppose at game start, you want to have the player's start position seem to differ by difficulty level. Simply start the player in a black room (probably any dark plain area will do), wait a moment for worldspawn to subside, then teleport.''

	* Create an info_player_teleport ~~(NOT the tdm one NOR the func_teleport.)~~		* Create an info_player_teleport entity, and move it to the first place where you want the player for difficulty Easy.
	~~(Easiest way to find this is click on base then SHIFT + RIGHT ARROW to open full list then type info_player_teleport)~~
	* Move it to the first place where you want the player for difficulty Easy.
	* Rotate it the way you want the player to face.		* Rotate it the way you want the player to face.
	* Give it diff_1_nospawn 1 and diff_2_nospawn 1, so it only appears on Easy.		* Give it diff_1_nospawn 1 and diff_2_nospawn 1, so it only appears on Easy.

Geep: /* Stumpy's Alternate Method */

2020-10-31T15:19:08Z

Stumpy's Alternate Method

← Older revision		Revision as of 15:19, 31 October 2020
Line 48:		Line 48:
	== Stumpy's Alternate Method ==		== Stumpy's Alternate Method ==

			''Suppose at game start, you want to have the player's start position seem to differ by difficulty level. Simply start the player in a black room (probably any dark plain area will do), wait a moment for worldspawn to subside, then teleport.''

	* Create an info_player_teleport (NOT the tdm one NOR the func_teleport.)		* Create an info_player_teleport (NOT the tdm one NOR the func_teleport.)
Line 56:		Line 57:
	* Clone it for Hard and change above to diff_0_nospawn 1 and diff_2_nospawn 1.		* Clone it for Hard and change above to diff_0_nospawn 1 and diff_2_nospawn 1.
	* Clone it for Expert and change above to diff_0_nospawn 1 and diff_1_nospawn 1.		* Clone it for Expert and change above to diff_0_nospawn 1 and diff_1_nospawn 1.
	* ~~Put~~ the ~~player in~~ a ~~black room (probably any dark plain area will do.)~~		* Create a delay mechanism, and give it the three teleports as targets. Example mechanisms:
	* Create a door ~~where~~ it can't be seen in the game ~~(or target a trigger_relay with brief delay from worldspawn~~).		** Target a trigger_relay with brief delay from worldspawn
	* Give it:		** Create a door (anywhere it can't be seen in the game), and give it auto_open_time 0.01
	* auto_open_time 0.01
	* Then three targets to each of the teleports


	{{editing}}		{{editing}}

RJFerret: /* Stumpy's Alternate Method */ fixed nospawn difficulty level args (was originally not spawning easy location on easy, but for both medium/hard, etc.)

2014-01-29T03:39:39Z

Stumpy's Alternate Method: fixed nospawn difficulty level args (was originally not spawning easy location on easy, but for both medium/hard, etc.)

← Older revision		Revision as of 03:39, 29 January 2014
Line 53:		Line 53:
	* Move it to the first place where you want the player for difficulty Easy.		* Move it to the first place where you want the player for difficulty Easy.
	* Rotate it the way you want the player to face.		* Rotate it the way you want the player to face.
	* Give it ~~diff_0_nospawn~~ 1		* Give it diff_1_nospawn 1 and diff_2_nospawn 1, so it only appears on Easy.
	* Clone it for Hard and change above to ~~diff_1_nospawn~~ 1		* Clone it for Hard and change above to diff_0_nospawn 1 and diff_2_nospawn 1.
	* Clone it for Expert and change above to ~~diff_2_nospawn~~ 1		* Clone it for Expert and change above to diff_0_nospawn 1 and diff_1_nospawn 1.
	* Put the player in a black room (probably any dark plain area will do.)		* Put the player in a black room (probably any dark plain area will do.)
	* Create a door where it can't be seen in the game.		* Create a door where it can't be seen in the game (or target a trigger_relay with brief delay from worldspawn).
	* Give it:		* Give it:
	* auto_open_time 0.01		* auto_open_time 0.01

Nbohr1more: /* Stumpy's Alternate Method */

2010-10-27T22:43:24Z

Stumpy's Alternate Method

← Older revision		Revision as of 22:43, 27 October 2010
Line 49:		Line 49:


	* Create an info_player_teleport (NOT the tdm one NOR the func_teleport.)		* Create an info_player_teleport (NOT the tdm one NOR the func_teleport.)
	* (Easiest way to find this is click on base then SHIFT + RIGHT ARROW to open full list then type info_player_teleport)		(Easiest way to find this is click on base then SHIFT + RIGHT ARROW to open full list then type info_player_teleport)
	* Move it to the first place where you want the player for difficulty Easy.		* Move it to the first place where you want the player for difficulty Easy.
	* Rotate it the way you want the player to face.		* Rotate it the way you want the player to face.

Nbohr1more at 22:42, 27 October 2010

2010-10-27T22:42:50Z

← Older revision		Revision as of 22:42, 27 October 2010
Line 49:		Line 49:


	* Create an info_player_teleport (NOT the tdm one NOR the func_teleport.)		* Create an info_player_teleport (NOT the tdm one NOR the func_teleport.)
	* (Easiest way to find this is click on base then SHIFT + RIGHT ARROW to open full list then type info_player_teleport)		* (Easiest way to find this is click on base then SHIFT + RIGHT ARROW to open full list then type info_player_teleport)
	* Move it to the first place where you want the player for difficulty Easy.		* Move it to the first place where you want the player for difficulty Easy.
	* Rotate it the way you want the player to face.		* Rotate it the way you want the player to face.
	* Give it diff_0_nospawn 1		* Give it diff_0_nospawn 1
	* Clone it for Hard and change above to diff_1_nospawn 1		* Clone it for Hard and change above to diff_1_nospawn 1
	* Clone it for Expert and change above to diff_2_nospawn 1		* Clone it for Expert and change above to diff_2_nospawn 1
	* Put the player in a black room (probably any dark plain area will do.)		* Put the player in a black room (probably any dark plain area will do.)
	* Create a door where it can't be seen in the game.		* Create a door where it can't be seen in the game.
	* Give it:		* Give it:
	* auto_open_time 0.01		* auto_open_time 0.01
	* Then three targets to each of the teleports		* Then three targets to each of the teleports


	{{editing}}		{{editing}}