Path Nodes - Revision history

Geep: /* How Close to Follow */

2025-01-21T20:59:09Z

How Close to Follow

← Older revision		Revision as of 20:59, 21 January 2025
Line 258:		Line 258:
	* distance_follower_catchup_distance N		* distance_follower_catchup_distance N
	* distance_follower_stop_running N		* distance_follower_stop_running N

			with defaults:
			* distance_follower_reached 60
			* distance_follower_catchup_distance 480
			* distance_follower_stop_running 180

	=== Example and Known Limitations ===		=== Example and Known Limitations ===

Geep: /* Example */

2025-01-21T20:32:36Z

Example

← Older revision		Revision as of 20:32, 21 January 2025
Line 259:		Line 259:
	* distance_follower_stop_running N		* distance_follower_stop_running N

	=== Example ===		=== Example and Known Limitations ===
	There is prefab, ai/paths/path_follow_actor.pfbx, that you can take a look at to get a full idea of the setup.		There is prefab, ai/paths/path_follow_actor.pfbx, that you can take a look at to get a full idea of the setup.

			There can be undesirable behavior at path_wait nodes, or with multiple followers. For more, see [https://bugs.thedarkmod.com/view.php?id=6552 bugtracker 6552].

	= How to Make AI do Random Interesting Things (RIT) =		= How to Make AI do Random Interesting Things (RIT) =

Geep: /* path_follow_actor */

2025-01-21T20:21:22Z

path_follow_actor

← Older revision		Revision as of 20:21, 21 January 2025
Line 253:		Line 253:
	'''IMPORTANT''': The atdm:target_changetarget entity must be triggered BEFORE the AI reaches the path_follow_actor node or it won't work. The AI will just stand there and do nothing.		'''IMPORTANT''': The atdm:target_changetarget entity must be triggered BEFORE the AI reaches the path_follow_actor node or it won't work. The AI will just stand there and do nothing.

			=== How Close to Follow ===
	To specify the distance of following there are 3 spawnargs:		To specify the distance of following, there are 3 spawnargs you may place on the follower:
	* distance_follower_reached N		* distance_follower_reached N
	* distance_follower_catchup_distance N		* distance_follower_catchup_distance N
	* distance_follower_stop_running N		* distance_follower_stop_running N

			=== Example ===
			There is prefab, ai/paths/path_follow_actor.pfbx, that you can take a look at to get a full idea of the setup.

	= How to Make AI do Random Interesting Things (RIT) =		= How to Make AI do Random Interesting Things (RIT) =

Datiswous: /* path_follow_actor */

2025-01-21T15:39:55Z

path_follow_actor

← Older revision		Revision as of 15:39, 21 January 2025
Line 252:		Line 252:

	'''IMPORTANT''': The atdm:target_changetarget entity must be triggered BEFORE the AI reaches the path_follow_actor node or it won't work. The AI will just stand there and do nothing.		'''IMPORTANT''': The atdm:target_changetarget entity must be triggered BEFORE the AI reaches the path_follow_actor node or it won't work. The AI will just stand there and do nothing.


			To specify the distance of following there are 3 spawnargs:
			* distance_follower_reached N
			* distance_follower_catchup_distance N
			* distance_follower_stop_running N

	= How to Make AI do Random Interesting Things (RIT) =		= How to Make AI do Random Interesting Things (RIT) =

Frost Salamander: /* path_follow_actor */

2024-05-11T15:07:19Z

path_follow_actor

@@ Line 214: / Line 214: @@
 ''Added in 2024, as of TDM 2.12''
-This tells the AI that targets this path to follow the actor (= other AI, not player) targetted by this path.
+This tells the AI that targets this path to follow the actor (either another AI or the player) targetted by this path.  The method used for setup depends on the choice of actor.
-Caution. This will let one AI follow another, but not for an AI to follow the player.
+=== Other AI as Actor ===
-For that, a [https://bugs.thedarkmod.com/view.php?id=6516 bug report] has been filed.
+If you want an AI to follow another AI, you can do the following directly in DarkRadiant:
-In the meantime, for a workaround by grodenglaive and others, see
+# Create a leader AI and a follower AI
-[https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=493694 here] with further modification
+# Create a path_follow_actor node
-[https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=493897 here]
+# Make the 'follower' AI target the path_follow_actor node (either directly or indirectly at the end of a path node chain)
-and resulting example
+# Make the path_follow_actor node target the 'leader'
-[https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=493755 test map].
+# When the follower AI gets to the path_follow_actor node, it will start following the leader AI.
 = How to Make AI do Random Interesting Things (RIT) =

Geep: Add path_follow_actor

2024-04-13T15:23:59Z

Add path_follow_actor

← Older revision		Revision as of 15:23, 13 April 2024
Line 210:		Line 210:

	These are special purpose and discussed below under '''Flee Points'''.		These are special purpose and discussed below under '''Flee Points'''.

			== path_follow_actor ==
			''Added in 2024, as of TDM 2.12''

			This tells the AI that targets this path to follow the actor (= other AI, not player) targetted by this path.

			Caution. This will let one AI follow another, but not for an AI to follow the player.
			For that, a [https://bugs.thedarkmod.com/view.php?id=6516 bug report] has been filed.
			In the meantime, for a workaround by grodenglaive and others, see
			[https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=493694 here] with further modification
			[https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=493897 here]
			and resulting example
			[https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=493755 test map].

	= How to Make AI do Random Interesting Things (RIT) =		= How to Make AI do Random Interesting Things (RIT) =

Geep: /* Switching Immediately (TDM 2.08+) */ typo

2021-12-30T15:42:09Z

Switching Immediately (TDM 2.08+): typo

← Older revision		Revision as of 15:42, 30 December 2021
Line 289:		Line 289:
	$Robert.setAlertLevel(1.6);		$Robert.setAlertLevel(1.6);
	sys.trigger($ChangeRobertsPatrol);		sys.trigger($ChangeRobertsPatrol);
	Robert.setKey("alert_idle", "1");		$Robert.setKey("alert_idle", "1");

	Robert is put into the Observant state by setAlertLevel(1.6). From there, at some point he'll drop back into Idle State, where a decision is made based on "I saw evidence of an intruder" as to whether to unsheathe the weapon or not. That evidence will be then forced by using Robert.setKey("alert_idle", "1").		Robert is put into the Observant state by setAlertLevel(1.6). From there, at some point he'll drop back into Idle State, where a decision is made based on "I saw evidence of an intruder" as to whether to unsheathe the weapon or not. That evidence will be then forced by using Robert.setKey("alert_idle", "1").

Geep: /* Switching Immediately (TDM 2.08+) */

2021-12-29T23:30:41Z

Switching Immediately (TDM 2.08+)

← Older revision		Revision as of 23:30, 29 December 2021
Line 264:		Line 264:

	== Switching Immediately (TDM 2.08+) ==		== Switching Immediately (TDM 2.08+) ==
	by Geep 2021, from [[https://bugs.thedarkmod.com/view.php?id=5056 grayman]]		''by Geep 2021, from [https://bugs.thedarkmod.com/view.php?id=5056 grayman]''

	As discussed above, you can re-route an AI to a new path by changing a target on an upcoming path node. But the AI won't make the path change until hitting the path node that was changed. Alternatively, as of TDM 2.08, you can immediately stop the current patrol and switch the AI to a new path, by scripting with the AI event "stopPatrol", e.g.:		As discussed above, you can re-route an AI to a new path by changing a target on an upcoming path node. But the AI won't make the path change until hitting the path node that was changed. Alternatively, as of TDM 2.08, you can immediately stop the current patrol and switch the AI to a new path, by scripting with the AI event "stopPatrol", e.g.:

Geep: Add the Switching Immediately section

2021-12-29T23:28:55Z

Add the Switching Immediately section

← Older revision		Revision as of 23:28, 29 December 2021
Line 238:		Line 238:


	= Switching from ~~one~~ Path ~~network~~ to ~~another~~ =		= Switching from One Path Network to Another =
			== When Reaching a Path Node ==

	Suppose you want to have an AI patrol outside a mansion for the first part of a mission, and then change his route to patrol in another location later?		Suppose you want to have an AI patrol outside a mansion for the first part of a mission, and then change his route to patrol in another location later?
Line 256:		Line 257:
	'''Other ideas:'''		'''Other ideas:'''

	'''Doormen'''-- An AI (or the player) walks up to the door and knocks on it. AI inside is triggered to walk over to the door and open it, then go back to his regular duties.		* '''Doormen'''-- An AI (or the player) walks up to the door and knocks on it. AI inside is triggered to walk over to the door and open it, then go back to his regular duties.
			* '''Abandon ship!''' -- When triggered, all AI drop what they're doing and start running for the exits.
			* '''Lights out!''' -- At a specific time, all AI stop what they're doing and walk to their beds to go to sleep.
			* '''Re-use, recycle''' -- AI that are stuck back in a portion of the map the player won't be coming back to could be told to walk to a new portion of the map and assume some job there.
			* '''It's a trap!''' -- Player walks down a hall and hits a trigger that causes AI to quickly position themselves at the only exits.

	~~'''Abandon ship!''' -- When triggered~~, ~~all AI drop what they're doing and start running for the exits~~.		== Switching Immediately (TDM 2.08+) ==
			by Geep 2021, from [[https://bugs.thedarkmod.com/view.php?id=5056 grayman]]

	~~'''Lights out!'''~~ -~~- At~~ a ~~specific time~~, ~~all AI~~ stop ~~what they're doing~~ and ~~walk~~ to ~~their beds to go to sleep~~.		As discussed above, you can re-route an AI to a new path by changing a target on an upcoming path node. But the AI won't make the path change until hitting the path node that was changed. Alternatively, as of TDM 2.08, you can immediately stop the current patrol and switch the AI to a new path, by scripting with the AI event "stopPatrol", e.g.:

	~~'''Re-use, recycle''' -- AI that are stuck back in a portion of the map the player won't be coming back to could be told to walk to a new portion of the map and assume some job there~~.		$Robert.stopPatrol();

	It''~~''s~~ a ~~trap!''' -- Player walks down a hall and hits a trigger that causes AI~~ to ~~quickly position themselves at~~ the ~~only exits~~.		This stops Robert wherever he is, and he'll wait for subsequent commands to put him on his new path. For example, to immediately put Robert on his new path, use this in your script file:

			$Robert.stopPatrol();
			sys.trigger($ChangeRobertsPatrol);

			where ChangeRobertsPatrol is an atdm:target_changetarget with spawnargs such as:

			"add" "path_corner_my_new_path"
			"target" "Robert"

			As usual, if you want Robert to run instead of walk to his new path, "path_corner_my_new_path" should have this set:

			"run" "1"

			If you want Robert to unsheathe his weapon while he runs to his new path, and patrol his new path with his weapon out, do this:

			$Robert.stopPatrol();
			$Robert.setAlertLevel(1.6);
			sys.trigger($ChangeRobertsPatrol);
			Robert.setKey("alert_idle", "1");

			Robert is put into the Observant state by setAlertLevel(1.6). From there, at some point he'll drop back into Idle State, where a decision is made based on "I saw evidence of an intruder" as to whether to unsheathe the weapon or not. That evidence will be then forced by using Robert.setKey("alert_idle", "1").

	= Flee Points =		= Flee Points =

Geep: /* Flee Points */ updated rewrite more

2021-12-18T20:56:16Z

Flee Points: updated rewrite more

← Older revision		Revision as of 20:56, 18 December 2021
Line 206:		Line 206:

	Used to script AI attacking a particular enemy, presumably for scripted sequences. Specifically, the AI will attack the character specified by the 'enemy' key. The AI will go to next path when the enemy dies or when activated.		Used to script AI attacking a particular enemy, presumably for scripted sequences. Specifically, the AI will attack the character specified by the 'enemy' key. The AI will go to next path when the enemy dies or when activated.

			== path_flee_point ==

			These are special purpose and discussed below under '''Flee Points'''.

	= How to Make AI do Random Interesting Things (RIT) =		= How to Make AI do Random Interesting Things (RIT) =
Line 265:		Line 269:
	''updated by Geep, based mostly on [https://bugs.thedarkmod.com/view.php?id=3548 grayman's bugtracker entry 3548] and related Flee Points forum thread''		''updated by Geep, based mostly on [https://bugs.thedarkmod.com/view.php?id=3548 grayman's bugtracker entry 3548] and related Flee Points forum thread''

	Do NOT target the AI to a flee point; ~~AI will automatically go to a flee point if in danger.~~ Just make available path_flee_point entities at suitable places where you would like your AI to flee to.		AI, e.g., civilians, will automatically flee if in danger. By default, they will flee to the furthest from danger they can reach by AAS pathfinding. Since this will not always result in believable behavior, you can provide "flee point" alternatives.

			Do NOT target the AI to a flee point; Just make available '''path_flee_point''' entities at suitable places where you would like your AI to flee to.

	~~===Attributes of Flee Points===~~		An AI that is fleeing from you can be chased from one flee point to another. Conversely, once fled, when enough time elapses without further danger, the AI may return, unless you arrange otherwise (through teleport or removal).
	A flee point ~~is considered ''Guarded'' if it has spawnarg "is_guarded 1"~~. ~~A fleeing AI~~, ~~e.g.~~, ~~a civilian~~, ~~would give this preference~~ (~~but it is up to the mapper to actually provide a guard there~~.)

	Let's define here some further categorization, comparing the team of the fleeing AI with ~~a "team" spawnarg you~~ set on ~~the~~ flee point:		===Spawnargs===
	* ''Friends''. Either the ''same'' team or one that is "friendly" (see [[~~Teams~~]])		These are optional but usually set:

			team ''<number>''
			is_guarded 1

			These influence where a fleeing AI goes. A flee point with "is_guarded 1" is considered ''Guarded''. But, of course, it is up to the mapper to actually provide a guard there; and a loitering guard will typically run towards the source of danger, rather than staying fixed near, say, a flee point.

			===Where the Fleeing AI Tries to Run===
			Let's define here some further categorization, comparing the team of the fleeing AI with that set on any given flee point:
			* ''Friends''. Either the ''same'' team or one that is "friendly" (see [[AI Relations (Editing)]])
	* ''Indifferent''. Either a team that is "neutral", or no "team" spawnarg given on the flee point		* ''Indifferent''. Either a team that is "neutral", or no "team" spawnarg given on the flee point
	* ''Hostile''. Otherwise.		* ''Hostile''. Otherwise.

	~~===Where the Fleeing AI Tries to Run===~~
	As of TDM 2.03, the AI will seek the existence of an accessible flee point in this order:		As of TDM 2.03, the AI will seek the existence of an accessible flee point in this order:

Line 290:		Line 303:
	* If the fleeing AI is allowed to use elevators generally, it can also use them to flee.		* If the fleeing AI is allowed to use elevators generally, it can also use them to flee.

	~~===Other Notes===~~		For reference, the wiki description of the pre-TDM-2.03 flee-choice algorithm is also provided (see button right).
	* A fleeing AI's bark cry for help alerts other AI and conveys the last alert position. Consequently, armed guard would go to investigate to the right place whereas another civilian might also flee away from it.
	* Armed AI will also flee if their health points drop to a certain level, as determined by the health_critical spawnarg.
	* For reference, the wiki description of the pre-TDM-2.03 flee-choice algorithm is also provided (see button right).
	<div class="mw-collapsible mw-collapsed" data-expandtext="Show" data-collapsetext="Hide">		<div class="mw-collapsible mw-collapsed" data-expandtext="Show" data-collapsetext="Hide">

Line 306:		Line 316:

	A problem occurs when the AI doesn't find any appropriate flee points but also no AAS area that is far away enough from the enemy. In this case, he will just stand there. Maybe he should either cower and be afraid in this case or just run around like a mad chicken?		A problem occurs when the AI doesn't find any appropriate flee points but also no AAS area that is far away enough from the enemy. In this case, he will just stand there. Maybe he should either cower and be afraid in this case or just run around like a mad chicken?
			</div>

			===When will a Civilian or Unarmed AI Flee?===
			''Geep: summarized mostly from [https://bugs.thedarkmod.com/view.php?id=3317 here] and [https://forums.thedarkmod.com/index.php?/topic/14471-ai-dont-care-about-violent-deaths/&do=findComment&comment=305947 here].''

	</~~div>~~		An AI will perceive danger and flee:
			* upon spotting an enemy (e.g., the player), either
			** immediately, or
			** after becoming suspicious and searching
			* upon being attacked (e.g., by surprise but inconclusively)
			* upon hearing a warning bark from another friendly AI
			* if witness to a murder or KO of a friend or neutral (not necessarily seeing the attacker)
			* if finding a friend's body that was murdered or KO'd
			* if finding a body of a neutral that was murdered or KO'd
			** within 4 seconds of the murder/KO, or
			** later, with 50% flee probability, 50% ignore.

			===When will an Armed AI Flee?===
			An Armed AI in a dangerous situation will flee if its health points drop to a certain level, as determined by its health_critical spawnarg.

			===Kneeling and Barks===
			If a civilian or unarmed AI finds a body (without witnessing the attack), there's a 50% chance it will kneel to inspect it.

			A fleeing AI will bark a warning, that varies on circumstances. A cry for help alerts other AI and conveys the last alert position. Consequently, armed guard would go to investigate to the right place whereas another civilian might also flee away from it.

	= Removing an AI from the Game =		= Removing an AI from the Game =