trigger_proximity
trigger_proximity
is a brush entity available in all Source games. It measures the distance of an entity within the trigger volume from a given point (and within a given radius). The NearestEntityDistance output will be 0 when the entity is at the center point, and 1 when the entity is at the radius.
Note:This entity cannot reliably detect when an entity exits the radius, which makes it only useful for detecting when one entity approaches another. This is due to the
NearestEntityDistance
output only firing while the entity is inside the radius, and that it sends a parameter of only 0 or 1, depending on if the entity is near the center (0) or at the edge (1). These are the only times that the parameter changes. Use the OnEndTouch
output of trigger_multiple instead to detect when the entity moves away.Tip:The main use of this entity is to detect proximity to a dynamic entity that can rotate, since the detection area is a consistent sphere. Spherical parented triggers are possible, but spherical brushes are not recommended.
Note:This entity does NOT work well in MP maps. It will function, but it will then break all other triggers in the map if you have multiple players in the map. Solo will show all the triggers working correctly though.
Contents
Keyvalues
- Point to Measure From <targetname>
- The name of the target entity, the origin of which is the point to measure another entity's distance from.
- Radius to measure within <string>
- The radius to which the distance should be mapped. Entities outside the radius 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 the
Enable
input).
Flags
BaseTrigger:
- [
4
] : func_pushable
- [
8
] : Physics Objects
- [
16
] : Only player ally NPCs
- [
32
] : Only clients in vehicles
- [
64
] : Everything (not including physics debris)
- [
512
] : Only clients *not* in vehicles
- [
1024
] : Physics debris
- [
2048
] : Only NPCs in vehicles (respects player ally flag)
- [
4096
] : Disallow Bots
Inputs
BaseTrigger:
Toggle
- Toggles this trigger between enabled and disabled states.
Enable
- Enable trigger
Disable
- Disable trigger
TouchTest
(in all games since )- Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
StartTouch
(in all games since ) !FGD- Behave as if the
!caller
entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch
(in all games since ) !FGD- Behave as if !caller had just exited the trigger volume.
Outputs
NearestEntityDistance
<integer>- 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.
BaseTrigger:
OnStartTouch
- Fired when a valid entity starts touching this trigger.
!activator
is whatever touches the trigger.
OnStartTouchAll
- 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
- Fired when a valid entity stops touching this trigger.
Warning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
OnEndTouchAll
- Fired when all valid entities stop touching this trigger.