Atdm:target postscriptevent - Revision history

Frost Salamander: add note about target_postscriptevent not working as expected and offering workaround

2024-03-13T18:57:50Z

add note about target_postscriptevent not working as expected and offering workaround

← Older revision		Revision as of 18:57, 13 March 2024
Line 51:		Line 51:

	On the right is a screenshot with a trigger, that when triggered, will use the shown atdm:target_postscriptevent entity to delete the linked torch after 1 second delay:		On the right is a screenshot with a trigger, that when triggered, will use the shown atdm:target_postscriptevent entity to delete the linked torch after 1 second delay:

			'''NOTE:''' This doesn't seem to work and results in the error: "'''IDEvent::Alloc: Wrong number of args for 'remove' event'''". You can accomplish the same goal in a similar fashion by using a '''func_remove''' entity instead.

	{{clear}}		{{clear}}

Tels: add see also

2009-07-24T11:41:39Z

add see also

← Older revision		Revision as of 11:41, 24 July 2009
Line 53:		Line 53:

	{{clear}}		{{clear}}

			== See also ==

			[[atdm:target_callobjectfunction]]

	{{editing}}		{{editing}}

Tels: Add an example and default values

2009-07-24T08:31:49Z

Add an example and default values

← Older revision		Revision as of 08:31, 24 July 2009
Line 11:		Line 11:
	=== event ===		=== event ===

	The '''event''' spawnarg gives the name of the script event. Examples:		The '''event''' spawnarg gives the name of the script event. Examples of events with '''pass_self''' false ("0"):

	* "teleportTo" (in combination with "pass_self" "1"!)
	* "Off", "On" (for lights)		* "Off", "On" (for lights)
	* "remove" (deletes that entity)		* "remove" (deletes that entity)
	* "activate" (activate that entity)		* "activate" (activate that entity)
	* "activateTargets"		* "activateTargets"

			Examples of events with '''pass_self''' true ("1"):

			* "teleportTo"

	and so on. A full list of available events can be found in the files <code>script/doom_events.script</code> and <code>script/tdm_events.script</code>.		and so on. A full list of available events can be found in the files <code>script/doom_events.script</code> and <code>script/tdm_events.script</code>.

	=== delay ===		=== delay (float, default: 0) ===

	The '''delay''' spawnarg specifies an initial delay in seconds, before the first event will be fired.		The '''delay''' spawnarg specifies an initial delay in seconds, before the first event will be fired.

	=== wait ===		=== wait (float, default: 0) ===

	The '''wait''' spawnarg specifies the delay in seconds between each subsequent event (e.g. between one and the next target).		The '''wait''' spawnarg specifies the delay in seconds between each subsequent event (e.g. between one and the next target).

	=== pass_self ===		=== pass_self (bool, default: false) ===

	For certain events that require as parameter an entity, you can set '''pass_self''' to true. The event will then get the trigger entity passed along as first parameter. Useful and mandatory for instance for <code>teleportTo</code>.		For certain events that require as parameter an entity, you can set '''pass_self''' to true. The event will then get the trigger entity passed along as first parameter. Useful and mandatory for instance for <code>teleportTo</code>.

	=== propagate_to_team ===		=== propagate_to_team (bool, default: false) ===

	If '''propagate_to_team''' is set to true ("1"), then the event will also be posted to any bound children of the targeted entities. This is important if you target [[combined light entities]], like a candle holder. Instead of sending '''Off()''' to the holder, you want it to arrive at the flame, but cannot target the flame in your map because it does not exist yet.		If '''propagate_to_team''' is set to true ("1"), then the event will also be posted to any bound children of the targeted entities. This is important if you target [[combined light entities]], like a candle holder. Instead of sending '''Off()''' to the holder, you want it to arrive at the flame, but cannot target the flame in your map because it does not exist yet.

	Events that are not suited for one type of entity (like Off() for non-lights) will be safely filtered out, so you can target them without worry at the base entity.		Events that are not suited for one type of entity (like Off() for non-lights) will be safely filtered out, so you can target them without worry at the base entity.

			'''Note:''' Turning of lights on combined entities does not yet work, I am working on it.

			== Examples ==

			=== How to delete entities ===

			[[Image:Postscriptevent.png\|400px\|right]]

			On the right is a screenshot with a trigger, that when triggered, will use the shown atdm:target_postscriptevent entity to delete the linked torch after 1 second delay:

			{{clear}}

			{{editing}}

Tels: fix link

2009-07-23T16:44:34Z

fix link

← Older revision		Revision as of 16:44, 23 July 2009
Line 35:		Line 35:
	=== propagate_to_team ===		=== propagate_to_team ===

	If '''propagate_to_team''' is set to true ("1"), then the event will also be posted to any bound children of the targeted entities. This is important if you target [[combined entities]], like a candle holder. Instead of sending '''Off()''' to the holder, you want it to arrive at the flame, but cannot target the flame in your map because it does not exist yet.		If '''propagate_to_team''' is set to true ("1"), then the event will also be posted to any bound children of the targeted entities. This is important if you target [[combined light entities]], like a candle holder. Instead of sending '''Off()''' to the holder, you want it to arrive at the flame, but cannot target the flame in your map because it does not exist yet.

	Events that are not suited for one type of entity (like Off() for non-lights) will be safely filtered out, so you can target them without worry at the base entity.		Events that are not suited for one type of entity (like Off() for non-lights) will be safely filtered out, so you can target them without worry at the base entity.

Tels: add propagate_to_team

2009-07-23T16:43:41Z

add propagate_to_team

← Older revision		Revision as of 16:43, 23 July 2009
Line 7:		Line 7:
	== Spawnargs ==		== Spawnargs ==

	The following spawnargs ~~are important~~ on this entity:		The following spawnargs can be used on this entity:

	=== event ===		=== event ===
Line 21:		Line 21:
	and so on. A full list of available events can be found in the files <code>script/doom_events.script</code> and <code>script/tdm_events.script</code>.		and so on. A full list of available events can be found in the files <code>script/doom_events.script</code> and <code>script/tdm_events.script</code>.

	== delay ==		=== delay ===

	The '''delay''' spawnarg specifies an initial delay in seconds, before the first event will be fired.		The '''delay''' spawnarg specifies an initial delay in seconds, before the first event will be fired.

	== wait ==		=== wait ===

	The '''wait''' spawnarg specifies the delay in seconds between each subsequent event (e.g. between one and the next target).		The '''wait''' spawnarg specifies the delay in seconds between each subsequent event (e.g. between one and the next target).

	== pass_self ==		=== pass_self ===

	For certain events that require as parameter an entity, you can set '''pass_self''' to true. The event will then get the trigger entity passed along as first parameter. Useful and mandatory for instance for <code>teleportTo</code>.		For certain events that require as parameter an entity, you can set '''pass_self''' to true. The event will then get the trigger entity passed along as first parameter. Useful and mandatory for instance for <code>teleportTo</code>.

			=== propagate_to_team ===

			If '''propagate_to_team''' is set to true ("1"), then the event will also be posted to any bound children of the targeted entities. This is important if you target [[combined entities]], like a candle holder. Instead of sending '''Off()''' to the holder, you want it to arrive at the flame, but cannot target the flame in your map because it does not exist yet.

			Events that are not suited for one type of entity (like Off() for non-lights) will be safely filtered out, so you can target them without worry at the base entity.

Tels: add

2009-07-23T11:11:40Z

add

New page

== Introduction ==

The entity '''atdm::target_postscriptevent''' is a useful entity to call one script function (aka "post the script event to the entity") on multiple entities.

The entity is used for instance by '''atdm:teleport''' to [[Teleporting_entities|teleport one or more entities]].

== Spawnargs ==

The following spawnargs are important on this entity:

=== event ===

The '''event''' spawnarg gives the name of the script event. Examples:

* "teleportTo" (in combination with "pass_self" "1"!)
* "Off", "On" (for lights)
* "remove" (deletes that entity)
* "activate" (activate that entity)
* "activateTargets"

and so on. A full list of available events can be found in the files <code>script/doom_events.script</code> and <code>script/tdm_events.script</code>.

== delay ==

The '''delay''' spawnarg specifies an initial delay in seconds, before the first event will be fired.

== wait ==

The '''wait''' spawnarg specifies the delay in seconds between each subsequent event (e.g. between one and the next target).

== pass_self ==

For certain events that require as parameter an entity, you can set '''pass_self''' to true. The event will then get the trigger entity passed along as first parameter. Useful and mandatory for instance for <code>teleportTo</code>.