trigger_particle

From Valve Developer Community
Jump to navigation Jump to search
Info.png
This entity is not in the FGD by default.
See below for instructions on making it available.

trigger_particle is a brush entity available in Team Fortress 2 Team Fortress 2.

Entity description

This entity will dispatch a particle effect onto entities that start touching it.

Tip.pngTip:Stop the particle effect made by this entity by sending the player entity the input DispatchEffect with parameter ParticleEffectStop.

Keyvalues

Name (targetname) <string>
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

Particle Name (particle_name) <string>
Name of particle effect to use. See: List of TF2 Particles
Attach Name (attachment_name) <string>
Name of attachment to dispatch at. Can be left blank.
Attachment Type (attachment_type) <integer>
Type of attachment. Options:
  • 0: Create at absolute origin, don't follow (default)
  • 1: Create at absolute origin, and follow entity
  • 2: Create at custom origin, don't follow
  • 3: Create on attachment point, don't follow
  • 4: Create on attachment point, and follow entity
  • 5: Create at world origin
  • 6: Create at root bone, and follow entity

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

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
Toggle:
Toggle
Toggle the enabled/disabled status of this entity.

Outputs

BaseTrigger
Icon-Bug.pngBug:Spamming crouch jumps in a trigger can randomly fire OnStartTouch/OnEndTouch.
Confirm:Is it a Multiplayer issue only?
  [todo tested in ?]


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.