Triggering events when looking at something - Revision history

Frost Salamander: include example config for both non-AI and AI entities

2022-06-25T18:01:25Z

include example config for both non-AI and AI entities

← Older revision		Revision as of 18:01, 25 June 2022
Line 8:		Line 8:
	= The Setup =		= The Setup =
	== Deploying the trigger_look Scriptobject for non-AI Entities ==		== Deploying the trigger_look Scriptobject for non-AI Entities ==
			The following includes configuration for both AI and non-AI entities. This section is primarily for non-AI entities. See further down for more about looking at AI entities.

	On the object you want to trigger an event (let's call it here a "seen-object" or as a more specific example, a "shield"), add the spawnarg		On the object you want to trigger an event (let's call it here a "seen-object" or as a more specific example, a "shield"), add the spawnarg
	scriptobject trigger_look		scriptobject trigger_look # non-AI entities
			scriptobject ai_trigger_look # AI entities

	You must also do the following:		You must also do the following:
Line 16:		Line 18:
	* within that script folder, create a file called '''tdm_custom_scripts.script'''		* within that script folder, create a file called '''tdm_custom_scripts.script'''
	* add the following to the file:		* add the following to the file:
	#include "script/trigger_look.script"		#include "script/trigger_look.script" # for non-AI entities
			#include "script/ai_trigger_look.script" # for AI entities

	That's it. If the player does look at it, it will trigger all its targets.		That's it. If the player does look at it, it will trigger all its targets.

Frost Salamander at 17:51, 25 June 2022

2022-06-25T17:51:36Z

← Older revision		Revision as of 17:51, 25 June 2022
Line 1:		Line 1:
	''by Obsttortes; updated and extended by Geep''		''by Obsttortes; updated and extended by Geep''
	== Introduction ==		= Introduction =

	Triggering events in games is a nice feature that can be used to drive the story forwards or to create tension. There are already several possibilities for how events can be triggered in DarkRadiant. The most common ones are the player entering a specific area, taking an object, or fulfilling an objective.		Triggering events in games is a nice feature that can be used to drive the story forwards or to create tension. There are already several possibilities for how events can be triggered in DarkRadiant. The most common ones are the player entering a specific area, taking an object, or fulfilling an objective.
Line 6:		Line 6:
	This article describes how to get entities to trigger events, if the player looks at them.		This article describes how to get entities to trigger events, if the player looks at them.

	== The Setup ==		= The Setup =
	=== Deploying the ~~Trigger_Look~~ Scriptobject ===		== Deploying the trigger_look Scriptobject for non-AI Entities ==

	On the object you want to trigger an event (let's call it here a "seen-object" or as a more specific example, a "shield"), add the spawnarg		On the object you want to trigger an event (let's call it here a "seen-object" or as a more specific example, a "shield"), add the spawnarg
	scriptobject trigger_look		scriptobject trigger_look

			You must also do the following:
			* create a folder called 'script' in your FM directory
			* within that script folder, create a file called '''tdm_custom_scripts.script'''
			* add the following to the file:
			#include "script/trigger_look.script"

	That's it. If the player does look at it, it will trigger all its targets.		That's it. If the player does look at it, it will trigger all its targets.

Line 23:		Line 30:
	* "once": if set to 1, the entity will trigger its targets only once (default: 0)		* "once": if set to 1, the entity will trigger its targets only once (default: 0)

	== Remarks ==		=== Remarks ===

	If you fill in "entityname", be sure it is '''not''' the same value as "name" of the seen-object.		If you fill in "entityname", be sure it is '''not''' the same value as "name" of the seen-object.
Line 42:		Line 49:
	No check is made if the shield can be ''really'' seen. So if the player, for example, looks at it through a wall within the proper range, it will be activated, too. (Possibly this can be improved in the future. In the meantime, you should adjust the distance spawnarg to get the desired effect.)		No check is made if the shield can be ''really'' seen. So if the player, for example, looks at it through a wall within the proper range, it will be activated, too. (Possibly this can be improved in the future. In the meantime, you should adjust the distance spawnarg to get the desired effect.)

	== Looking at AI ==		== Deploying the ai_trigger_look Scriptobject for Looking at AI Entities ==

	This script should not be used as-is to look at an AI, because the AI will have a scriptobject already. If you override it with trigger_look, then the AI behavior fails. Instead, merge trigger_look functions with the AI's script object. An example of such a merger script is given
	~~[http://forums.thedarkmod.com/applications/core/interface/file/attachment.php?id=14101 here].~~

	~~See also~~ in the ~~TMD distribution:~~ tdm_base01/script/ai_trigger_look.script		trigger_look should not be used to look at an AI, because the AI will have a scriptobject already. If you override it with trigger_look, then the AI behavior fails. Instead, use the '''ai_trigger_look''' script object which merges trigger_look functions with the AI's script object. This can be set up in the same manner as trigger_look, just substitute 'ai_trigger_look' for 'trigger_look' in the setup steps above. The ai_trigger_look script can be found in tdm_base01/script/ai_trigger_look.script.

	Because of naming conflicts~~, instead of "tolerance" and "distance"~~, you must specify these parameters (which have no defaults):		Because of naming conflicts, you must specify these parameters as spawnargs on the AI entity (which have no defaults):
	* tol_angle		* tol_angle (akin to 'tolerance' in trigger_look)
	* tol_distance		* tol_distance (akin to 'distance' in trigger_look)

	== How the Trigger_Look Scriptobject Works ==		= How the Trigger_Look Scriptobject Works =

	The scriptobject is distributed within the TDM pk4 as		The scriptobject is distributed within the TDM pk4 as
Line 73:		Line 77:
	Finally, the first vector is normalized to a unit vector, and the "angle" variable (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.		Finally, the first vector is normalized to a unit vector, and the "angle" variable (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.

	== See Also ==		= See Also =
	[http://forums.thedarkmod.com/topic/14394-apples-and-peaches-obsttortes-mapping-and-scripting-thread/page__view__findpost__p__307416 Obsttortes Forum Thread] about this.		[http://forums.thedarkmod.com/topic/14394-apples-and-peaches-obsttortes-mapping-and-scripting-thread/page__view__findpost__p__307416 Obsttortes Forum Thread] about this.
	[[Category:Editing]]		[[Category:Editing]]

Geep: /* Introduction */

2020-03-24T16:05:20Z

Introduction

← Older revision		Revision as of 16:05, 24 March 2020
Line 2:		Line 2:
	== Introduction ==		== Introduction ==

	Triggering events in games is a nice feature that can be used to drive the story forwards or to create tension. There are already several possibilities for how events can be triggered in DarkRadiant. The most common ones are the player entering a specific area. taking an object, or fulfilling an objective.		Triggering events in games is a nice feature that can be used to drive the story forwards or to create tension. There are already several possibilities for how events can be triggered in DarkRadiant. The most common ones are the player entering a specific area, taking an object, or fulfilling an objective.

	This article describes how to get entities to trigger events, if the player looks at them.		This article describes how to get entities to trigger events, if the player looks at them.

Geep: /* Remarks */ Add tolerance equation

2020-03-24T16:03:23Z

Remarks: Add tolerance equation

← Older revision		Revision as of 16:03, 24 March 2020
Line 29:		Line 29:
	Interesting values of "tolerance" (speaking in terms of the x-y plane only) are		Interesting values of "tolerance" (speaking in terms of the x-y plane only) are
	* 0 = direct look only, like a rifle bore		* 0 = direct look only, like a rifle bore
	* 0.1 (default) = up to about 29 degrees from the direct-look axis (about 58 degrees total)		* 0.1 (default) = up to about 26 degrees from the direct-look axis (about 52 degrees total)
	* 1 = up to 90 degrees from direct-look axis (180 degrees total)		* 1 = up to 90 degrees from direct-look axis (180 degrees total)
	* 2 = no directionality (360 degrees total)		* 2 = no directionality (360 degrees total)

	In practice, values very close to zero or greater than 1 are unlikely to be useful.		In practice, values very close to zero or greater than 1 are unlikely to be useful. To calculate a tolerance value for a particular angle ''theta'' (which is half the total viewing angle):
			tolerance = 1 - cos(theta)

	The algorithm differs depending on who the triggering viewer is:		The algorithm differs depending on who the triggering viewer is:

Geep: /* Additional Spawnargs */

2020-03-24T15:42:51Z

Additional Spawnargs

← Older revision		Revision as of 15:42, 24 March 2020
Line 13:		Line 13:
	That's it. If the player does look at it, it will trigger all its targets.		That's it. If the player does look at it, it will trigger all its targets.

	== Additional Spawnargs ==		=== Additional Spawnargs ===

	There are some additional spawnargs that can be used to control the behaviour of this object. They are all optional.		There are some additional spawnargs that can be used to control the behaviour of this object. They are all optional.

Geep: /* The Setup of the Trigger_Look Scriptobject */

2020-03-24T15:42:27Z

The Setup of the Trigger_Look Scriptobject

← Older revision		Revision as of 15:42, 24 March 2020
Line 6:		Line 6:
	This article describes how to get entities to trigger events, if the player looks at them.		This article describes how to get entities to trigger events, if the player looks at them.

	== The Setup of the Trigger_Look Scriptobject ==		== The Setup ==
			=== Deploying the Trigger_Look Scriptobject ===

	On the object you want to trigger an event (let's call it a "shield" ~~here~~), add the spawnarg		On the object you want to trigger an event (let's call it here a "seen-object" or as a more specific example, a "shield"), add the spawnarg
	scriptobject trigger_look		scriptobject trigger_look
	That's it. If the player does look at it, it will trigger all its targets.		That's it. If the player does look at it, it will trigger all its targets.

Geep: Rearrange

2020-03-24T15:33:18Z

Rearrange

← Older revision		Revision as of 15:33, 24 March 2020
Line 1:		Line 1:
	''by Obsttortes; extended by Geep''		''by Obsttortes; updated and extended by Geep''
	== Introduction ==		== Introduction ==

Line 6:		Line 6:
	This article describes how to get entities to trigger events, if the player looks at them.		This article describes how to get entities to trigger events, if the player looks at them.

	== The ~~Scriptobject ==~~		== The Setup of the Trigger_Look Scriptobject ==

	~~The first thing you need is the latest version~~ of the ~~scriptobject, which is distributed within the TDM pk4 as~~
	~~tdm_base01/script/trigger_look.script~~
	~~Put this your script folder and include it by adding the line~~
	~~#include "script/trigger_look.script"~~
	~~in your tdm_custom_scripts.script file. If there is no such file, you have to create it.~~

	~~== The Setup~~ ==

	On the object you want to trigger an event (let's call it a "shield" here), add the spawnarg		On the object you want to trigger an event (let's call it a "shield" here), add the spawnarg
Line 30:		Line 22:
	* "once": if set to 1, the entity will trigger its targets only once (default: 0)		* "once": if set to 1, the entity will trigger its targets only once (default: 0)

	Interesting values of "tolerance" (~~which consider~~ the x-y plane only) are		== Remarks ==
	* 0 = direct look only
	* 0.1 (default) = up to about 29 degrees from the direct-look axis (about 58 degrees total).		If you fill in "entityname", be sure it is '''not''' the same value as "name" of the seen-object.

			Interesting values of "tolerance" (speaking in terms of the x-y plane only) are
			* 0 = direct look only, like a rifle bore
			* 0.1 (default) = up to about 29 degrees from the direct-look axis (about 58 degrees total)
	* 1 = up to 90 degrees from direct-look axis (180 degrees total)		* 1 = up to 90 degrees from direct-look axis (180 degrees total)
	* 2 = no directionality (360 degrees total)		* 2 = no directionality (360 degrees total)

	~~== Remarks ==~~		In practice, values very close to zero or greater than 1 are unlikely to be useful.

	The algorithm differs depending on ~~whether~~ the viewer is:		The algorithm differs depending on who the triggering viewer is:
	* ~~the player~~ - is the shield seen, i.e., in the player's field of view?		* The Player - is the shield seen, i.e., in the player's field of view (assuming the given tolerance)?
	* ~~another entity~~ - only checks whether it is facing in the correct direction (in the x-y-plane).		* Another Entity - only checks whether it is facing in the correct direction (in the x-y-plane).

	No check is made if the shield can be ''really'' seen. So if the player, for example, looks at it through a wall within the proper range, it will be activated, too. (Possibly this can be improved in the future. In the meantime, you should adjust the distance spawnarg to get the desired effect.)		No check is made if the shield can be ''really'' seen. So if the player, for example, looks at it through a wall within the proper range, it will be activated, too. (Possibly this can be improved in the future. In the meantime, you should adjust the distance spawnarg to get the desired effect.)
Line 55:		Line 51:
	* tol_distance		* tol_distance

	== How the Trigger_Look ~~Script~~ Works ==		== How the Trigger_Look Scriptobject Works ==

			The scriptobject is distributed within the TDM pk4 as
			tdm_base01/script/trigger_look.script
			(Any FM that used trigger_look before it was part of the standard distribution will have a copy in the FM's script folder as well as the line
			#include "script/trigger_look.script"
			in its script/tdm_custom_scripts.script file.)

	~~There~~ are two parts in the trigger_look workflow:		When you open the script with a text editor, you will see that there are two parts in the trigger_look workflow:
	# the stim, that enables the object, set up in "init"		# the stim, that enables the object, set up in "init"
	# the entity to react to.		# the entity to react to.
	~~These must not be the same!~~

	The heart of the script is the "processStim" function. It identifies the "inflictor", e.g. player1, and the		The heart of the script is the second part, the "processStim" function. It identifies the "inflictor", e.g. player1, and the object to be seen, e.g., a "shield", and by subtraction of their origins finds the vector from inflictor to seen-object. For a player-inflictor, the vector is adjusted in z to be "from the eyes" instead of from the origin "at the feet".
	object to be seen, e.g., a shield, and by subtraction of their origins finds the vector from inflictor
	to seen-object. For a player-inflictor, the vector is adjusted in z to be "from the eyes" instead of from the origin "at the feet".

	If the length of that vector exceeds the "distance" parameter, nothing will be triggered.		If the length of that vector exceeds the "distance" parameter, nothing will be triggered.
Line 70:		Line 69:
	Otherwise, the unit vector in the direction of the inflictor's view is retrieved. A function call gives this in terms of Euler angles. This is then converted to a direct unit vector, representing the "forward" view (and ignoring the "right" and "up" vectors). For a fuller explanation of the mathematics, see the video [https://youtu.be/5pnLZzrZTAo Trigger_look Explained].		Otherwise, the unit vector in the direction of the inflictor's view is retrieved. A function call gives this in terms of Euler angles. This is then converted to a direct unit vector, representing the "forward" view (and ignoring the "right" and "up" vectors). For a fuller explanation of the mathematics, see the video [https://youtu.be/5pnLZzrZTAo Trigger_look Explained].

	Finally, the first vector is normalized to a unit vector, and the "angle" (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.		Finally, the first vector is normalized to a unit vector, and the "angle" variable (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.

	== See Also ==		== See Also ==
	[http://forums.thedarkmod.com/topic/14394-apples-and-peaches-obsttortes-mapping-and-scripting-thread/page__view__findpost__p__307416 Obsttortes Forum Thread] about this.		[http://forums.thedarkmod.com/topic/14394-apples-and-peaches-obsttortes-mapping-and-scripting-thread/page__view__findpost__p__307416 Obsttortes Forum Thread] about this.
	[[Category:Editing]]		[[Category:Editing]]

Geep: /* Looking at AI */

2020-03-24T01:10:57Z

Looking at AI

← Older revision		Revision as of 01:10, 24 March 2020
Line 47:		Line 47:

	This script should not be used as-is to look at an AI, because the AI will have a scriptobject already. If you override it with trigger_look, then the AI behavior fails. Instead, merge trigger_look functions with the AI's script object. An example of such a merger script is given		This script should not be used as-is to look at an AI, because the AI will have a scriptobject already. If you override it with trigger_look, then the AI behavior fails. Instead, merge trigger_look functions with the AI's script object. An example of such a merger script is given
	[[http://forums.thedarkmod.com/applications/core/interface/file/attachment.php?id=14101 here]].		[http://forums.thedarkmod.com/applications/core/interface/file/attachment.php?id=14101 here].

	See also in the TMD distribution: tdm_base01/script/ai_trigger_look.script		See also in the TMD distribution: tdm_base01/script/ai_trigger_look.script

Geep: Add see also

2020-03-24T01:10:11Z

Add see also

← Older revision		Revision as of 01:10, 24 March 2020
Line 71:		Line 71:

	Finally, the first vector is normalized to a unit vector, and the "angle" (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.		Finally, the first vector is normalized to a unit vector, and the "angle" (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.

			== See Also ==
			[http://forums.thedarkmod.com/topic/14394-apples-and-peaches-obsttortes-mapping-and-scripting-thread/page__view__findpost__p__307416 Obsttortes Forum Thread] about this.
	[[Category:Editing]]		[[Category:Editing]]

Geep: /* How the Trigger_Look Script Works */ Fix video link

2020-03-24T00:56:49Z

How the Trigger_Look Script Works: Fix video link

← Older revision		Revision as of 00:56, 24 March 2020
Line 68:		Line 68:
	If the length of that vector exceeds the "distance" parameter, nothing will be triggered.		If the length of that vector exceeds the "distance" parameter, nothing will be triggered.

	Otherwise, the unit vector in the direction of the inflictor's view is retrieved. A function call gives this in terms of Euler angles. This is then converted to a direct unit vector, representing the "forward" view (and ignoring the "right" and "up" vectors). For a fuller explanation of the mathematics, see the video [[https://youtu.be/5pnLZzrZTAo]].		Otherwise, the unit vector in the direction of the inflictor's view is retrieved. A function call gives this in terms of Euler angles. This is then converted to a direct unit vector, representing the "forward" view (and ignoring the "right" and "up" vectors). For a fuller explanation of the mathematics, see the video [https://youtu.be/5pnLZzrZTAo Trigger_look Explained].

	Finally, the first vector is normalized to a unit vector, and the "angle" (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.		Finally, the first vector is normalized to a unit vector, and the "angle" (which is actually the cosine of the angle) between those 2 unit vectors is calculated. This is compared to "eps" (short for epsilon) which is 1 minus "tolerance", for triggering.
	[[Category:Editing]]		[[Category:Editing]]