This article's documentation is for anything that uses the Source engine. Click here for more information.

Trigger multiple: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(-BaseTrigger templates)
Line 6: Line 6:


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV|Delay Before Reset|intn=wait|float|Delay in seconds before ''OnTrigger'' can fire again, 0 defaults to 0.2. If set to -1, it will kill itself when triggered (as trigger_once), which means outputs like OnEntireTeamStartTouch can never fire.}}
{{KV|Delay Before Reset|intn=wait|float|Delay in seconds before ''OnTrigger'' can fire again, 0 defaults to 0.2. If set to -1, it will kill itself when triggered (as trigger_once), which means outputs like OnEntireTeamStartTouch can never fire.}}
{{KV|only=L4ds|intn=entireteam|Entire Team Number|choices|If the entire team is touching, fire OnEntireTeamStartTouch.}}
{{KV|only=L4ds|intn=entireteam|Entire Team Number|choices|If the entire team is touching, fire OnEntireTeamStartTouch.}}
Line 13: Line 14:
{{KV|only=L4ds|intn=allowincap|Incapacitated players can trigger|boolean|Whether incapacitated players can trigger.}}
{{KV|only=L4ds|intn=allowincap|Incapacitated players can trigger|boolean|Whether incapacitated players can trigger.}}
{{KV|only=L4ds|intn=allowghost|Ghost players can trigger|boolean|Whether ghost survivors can trigger.}}
{{KV|only=L4ds|intn=allowghost|Ghost players can trigger|boolean|Whether ghost survivors can trigger.}}
{{KV|Filter Name|intn=filtername|filter|Name of filter entity to test against activators.}}
{{KV BaseTrigger}}
{{KV EnableDisable}}
{{KV Targetname}}


==Flags==
==Flags==
{{Fl Trigger}}
{{Fl BaseTrigger}}


==Inputs==
==Inputs==
{{IO|TouchTest|Tests if the trigger is being touched and fires an output based on whether the value is true or false.}}
{{I BaseTrigger}}
{{I Trigger}}
{{I Trigger Chaos}}
{{I Trigger Chaos}}


==Outputs==
==Outputs==
{{IO|OnStartTouchAll|Fired when an entity starts touching this trigger, and no other entities are touching it. Only entities that passed this trigger's filters are considered.}}
{{IO|OnEntireTeamStartTouch|Fired when an entire team starts touching the trigger.|since=L4D}}
{{IO|OnEntireTeamStartTouch|Fired when an entire team starts touching the trigger.|since=L4D}}
{{IO|OnEntireTeamEndTouch|Fired when an entire team stops touching the trigger.|since=L4D}}
{{IO|OnEntireTeamEndTouch|Fired when an entire team stops touching the trigger.|since=L4D}}
{{O Trigger}}
{{IO|OnTrigger|Fired repeatedly with a delay while an entity is within this trigger's volume. Delay is defined by <tt>Delay Before Reset</tt> key.}}
{{O BaseTrigger}}


== See also ==
== See also ==

Revision as of 06:04, 8 August 2023

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CTriggerMultiple
↳CBaseTrigger
↳CBaseToggle
↳CBaseEntity
C++ triggers.cpp

Template:Entity It is a volume that fires outputs when a specified type of entity enters or leaves it.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Delay Before Reset (wait) <float>
Delay in seconds before OnTrigger can fire again, 0 defaults to 0.2. If set to -1, it will kill itself when triggered (as trigger_once), which means outputs like OnEntireTeamStartTouch can never fire.
Entire Team Number (entireteam) <choices> (only in Left 4 Dead seriesLeft 4 Dead series)
If the entire team is touching, fire OnEntireTeamStartTouch.
  • 0 : None
  • 2 : Survivor
  • 3 : Infected
Incapacitated players can trigger (allowincap) <boolean> (only in Left 4 Dead seriesLeft 4 Dead series)
Whether incapacitated players can trigger.
Ghost players can trigger (allowghost) <boolean> (only in Left 4 Dead seriesLeft 4 Dead series)
Whether ghost survivors can trigger.
BaseTrigger
Filter Name (filtername) <filter>
A filter entity to test potential activators against.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Flags

BaseTrigger
Everything (not including physics debris) : [64]
Clients (Survivors, Special Infected, Tanks Left 4 Dead seriesLeft 4 Dead series) : [1]
Only clients in vehicles : [32]
Only clients *not* in vehicles : [512]
Disallow Bots (removed since Left 4 Dead) : [4096]
NPCs (Common Infected, Witches Left 4 Dead seriesLeft 4 Dead series) : [2]
Only player ally NPCs : [16]
Only NPCs in vehicles (respects player ally flag) : [2048]
Physics Objects (not including physics debris) : [8]
Physics debris (include also physics debris) : [1024]
Pushables (Passes entities with classname func_pushable) : [4] Obsolete
Deprecated.
Equivalent to using Everything + filter_activator_class that filters func_pushable.

Inputs

BaseTrigger
Toggle
Toggles this trigger between enabled and disabled states.
Enable
Enable trigger
Disable
Disable trigger
TouchTest  (in all games since Source 2007)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
Icon-Bug.pngBug:Sleeping prop_physics will never fire "OnTouching". Also applies to entities using prop_physics as base.  (tested in: Half-Life 2)
StartTouch  (in all games since Source 2007) !FGD
Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch  (in all games since Source 2007) !FGD
Behave as if !caller had just exited the trigger volume.
DisableAndEndTouch  (only in Source 2013 MultiplayerTeam Fortress 2 branch)
Disables this trigger and calls EndTouch on all currently-touching entities.
StrataEngine:
Touch  (only in Strata Source Strata Source games)
Behaves as if !caller has touched the trigger volume


Outputs

OnEntireTeamStartTouch  (in all games since Left 4 Dead)
Fired when an entire team starts touching the trigger.
OnEntireTeamEndTouch  (in all games since Left 4 Dead)
Fired when an entire team stops touching the trigger.
OnTrigger
Fired repeatedly with a delay while an entity is within this trigger's volume. Delay is defined by Delay Before Reset key.
BaseTrigger
OnStartTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger.
OnStartTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger, and no other entities are touching it. If there are any other entities touching the trigger when a new one begins to touch, only OnStartTouch will fire.
OnEndTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity stops touching this trigger.
Note.pngNote:Will also fire for entities touching it when trigger is disabled via Disable input
Warning.pngWarning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
Warning.pngWarning:OnEndTouch can fire before OnStartTouch under certain circumstances[How?] where both are fired on the same tick and each have the same delay.
Note.pngFix:Add a slight delay to OnEndTouch.
OnEndTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when all valid entities stop touching this trigger.
OnTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if something is currently touching this trigger when TouchTest is fired.
OnNotTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if nothing is currently touching this trigger when TouchTest is fired.

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Trigger_multiple&oldid=336169"