Trigger proximity: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
m (Cleanup)
Line 1: Line 1:
{{wrongtitle|title=trigger_proximity}}
{{base brush|trigger_proximity}}
{{base_brush}}
{{sensor brush}}


==Entity Description==
==Entity Description==
Measures the distance of the player within the [[trigger]] volume from a given point (and within a given radius). The ''NearestPlayerDistance'' output will be 0 when the player is at the center point, and 1 when the player is at the radius.  
Measures the distance of the player within the [[trigger]] volume from a given point (and within a given radius). The ''NearestPlayerDistance'' output will be 0 when the player is at the center point, and 1 when the player is at the radius.


{{sensor_brush}}
{{code class|CTriggerProximity|trigger.cpp}}
 
In code it is represented by class CTriggerProximity, defined in trigger.cpp.


==Keyvalues==
==Keyvalues==
*{{KV Trigger}}
{{KV|Point to Measure From|target_destination|The name of a target entity who's origin is the point to measure the player's distance from.}}
*'''measuretarget'''
{{KV|Radius to measure within|string|The radius to which the distance should be mapped. If the player is outside the radius he will be ignored.}}
:<target_destination> The name of a target entity who's origin is the point to measure the player's distance from.
{{KV Trigger}}
*'''radius'''
:<float> The radius to which the distance should be mapped. If the player is outside the radius he will be ignored.


==Flags==
==Flags==
*{{Fl Trigger}}
{{Fl Trigger}}


==Inputs==
==Inputs==
*{{I Trigger}}
{{I Trigger}}


==Outputs==
==Outputs==
*{{O Trigger}}
{{IO|NearestEntityDistance|Fired continuously when entities are touching the trigger volume. The output parameter is the distance from the |param=integer}}
*'''NearestEntityDistance <integer>'''
{{O Trigger}}
:Fired continuously when entities are touching the trigger volume. The output parameter is the distance from the ''Point to Measure From'' to the nearest entity that passed the trigger filters. The distance is mapped to the radius distance, so it will be 0 when the entity is on the point, and 1 when the entity is at the edge of the radius.

Revision as of 07:54, 3 June 2011

Template:Base brush

Entity Description

Measures the distance of the player within the trigger volume from a given point (and within a given radius). The NearestPlayerDistance output will be 0 when the player is at the center point, and 1 when the player is at the radius.

C++ In code, it is represented by theCTriggerProximityclass, defined in thetrigger.cppfile.

Keyvalues

Point to Measure From ([todo internal name (i)]) <targetname>
The name of a target entity who's origin is the point to measure the player's distance from.
Radius to measure within ([todo internal name (i)]) <string>
The radius to which the distance should be mapped. If the player is outside the radius he will be ignored.
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.

Outputs

NearestEntityDistance <integerRedirectInput/integer>
Fired continuously when entities are touching the trigger volume. The output parameter is the distance from the
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.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Trigger_proximity&oldid=152182"