trigger_push

trigger_push is a brush entity available in all Source games. It is a trigger volume that pushes entities that touch it, except those with a parent.

In code, it is represented by class CTriggerPush, defined in triggers.cpp.

Keyvalues

Push Direction (Pitch Yaw Roll) <angle>

Angles indicating the direction to push touched entities.

Speed of Push <integer>

The speed at which to push entities away, in inches / second.

Scale force for alternate ticks <float>

If nonzero, scale the force by this amount when running with alternate ticks. This fixes problems with an overly large force due to the longer frametime on when running with sv_alternateticks 1.

Only Falling Players <boolean> (in all games since )

Only affect players if they are falling (and not pressing jump)

Player fall speed <float> (in all games since )

Player must be falling this fast for push to happen

Flags

• 128 : Once Only (possibly means set velocity rather than apply acceleration)
• 256 : Affects Ladders (Half-Life 2)

TriggerOnce:

•  [1] : Clients
•  [2] : NPCs
•  [4] : Pushables
•  [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
•  [4096] : Correctly account for object mass (trigger_push used to assume 100Kg) and multiple component physics objects (car, blob...) (in all games since )

 Note: In , flag 4096 is "Correctly account for object mass" for trigger_push only.^[confirm]

• 4096 : Disallow bots

Inputs

SetPushDir  (in all games since )

Sets the push angle of the trigger.

Confirm:In other games too?

SetSpeed  (only in )

Sets the push speed. Still takes alternate tick kv into account.

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 the !caller entity had just exited the trigger volume.

DisableAndEndTouch  (only in )

Disables this trigger and calls EndTouch on all currently-touching entities.

TriggerOnce:

Toggle

Toggles this trigger between enabled and disabled states.

EnableDisable:

Enable

Disable

Enable/disable this entity from performing its task. It might also disappear from view.

Base:

Kill

Removes this entity and any entities parented to it from the world.

KillHierarchy

Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than Kill.

SetParent <string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <string>

As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

ClearParent

Removes this entity from the the movement hierarchy, leaving it free to move independently.

AddOutput <string>

Evaluates a keyvalue/output on this entity.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>

FireUser1 to FireUser4

Fire the OnUser outputs; see User Inputs and Outputs.

Use  !FGD

Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.

DispatchEffect <string> (removed in ) !FGD

Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since .

DispatchResponse <string> !FGD

Dispatches a response to the entity. See Response and Concept.

AddContext <string>

Adds to the entity's list of response contexts. Format is <key>:<value>.

RemoveContext <string>

Remove a context from this entity's list. The name should match the key of an existing context.

ClearContext <string>

Removes all contexts from this entity's list.

RunScriptFile <script> (in all games since )

Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode <string> (in all games since )

Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.

 Bug:  In , the code is executed in the script scope of the entity that fires the output, not the one receiving the input.

 Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.

CallScriptFunction <string> (in all games since ) !FGD

Execute a VScript function in the scope of the receiving entity.

SetLocalOrigin <coordinates> (in all games since ) !FGD

Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.

SetLocalAngles <angles> (in all games since ) !FGD

Set this entity's angles.

Outputs

Trigger:

OnEndTouch

Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire. (activator is the exiting entity)

 Warning: This includes entities which are deleted while inside the trigger. In this case activator will be invalid.

OnEndTouchAll

Fires when the last entity in the entity's area exits this trigger or when this entity is disabled. Only entities that passed this trigger's filters are considered. (activator is the last exiting entity)

OnTouching  (in all games since )

OnNotTouching  (in all games since )

Fired when the TouchTest input is called.

TriggerOnce:

OnStartTouch

Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire. (activator is the toucher)

OnTrigger

Fired whenever the trigger is activated. (activator is the activator)

Base:

OnUser1 to OnUser4

These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.

OnKilled  (only in )

This output fires when the entity is killed and removed from the game.