BRUSH
trigger_remove
A trigger volume that removes any entities that touch it. Be careful, removing some entities can cause instability. This is not the same as killing entities. i.e. NPCs removed in this manner will not fire their OnKilled outputs.
KeyValues
Inherited from Trigger
spawnflags <flags>
No description provided.
Possible Flags:
Name | Value | Default |
Clients/Players | 1 | ✅ |
Allow ghosts to fire this trigger | 8192 | ❌ |
func_pushable | 4 | ❌ |
Physics Objects | 8 | ❌ |
Only explosives | 32 | ❌ |
Everything (not including physics debris) | 64 | ❌ |
Physics debris | 1024 | ❌ |
Correctly account for object mass (trigger_push used to assume 100Kg) and multiple component physobjs (car, blob...) | 4096 | ✅ |
Inherited from TriggerOnce
Start Disabled? <boolean> = No
No description provided.
Filter Name <filterclass>
A filter entity to test potential activators against.
Inherited from BaseEntityBrush
Name <target_source>
The name that other entities refer to this entity by.
Global Entity Name <string>
Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
Origin (X Y Z) <origin>
The position of this brush entity's center in the world. Rotating entities typically rotate around their origin.
Parent <target_destination>
The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent. Set an attachment point via 'parentname,attachment'.
Minimum Bounding Box Size <vector>
Co-ordinate of the minimum bounding box corner, relative to entity origin. The bounding box is drawn from this corner to the other one. Requires Bounding Box collisions (solid 2) to be used. Can be used to overwrite the collision shape of a brush, although it can only be a cuboid. Can be AddOutputed to change shape at runtime.
Maximum Bounding Box Size <vector>
Co-ordinate of the maximum bounding box corner, relative to entity origin. The bounding box is drawn from this corner to the other one. Requires Bounding Box collisions (solid 2) to be used. Can be used to overwrite the collision shape of a brush, although it can only be a cuboid. Can be AddOutputed to change shape at runtime.
Collisions <choices> = VPhysics (6)
Method of collision for this entity. Can be changed at runtime with AddOutput.
Possible Values:
Name | Value |
None | 0 |
BSP (QPhysics) | 1 |
Bounding Box | 2 |
Oriented Bounding Box | 3 |
Oriented Bounding Box, constrained to Yaw only | 4 |
Custom (defined per-entity, if not defined the entity will have bizarre collision behavior) | 5 |
VPhysics | 6 |
Inputs
Inherited from Trigger
EndTouch <void>
Fires the OnEndTouch output. If called by an entity inside the trigger, the OnEndTouch will be fired for them as the activator. Note that this input is passed even if the player is being treated as 'not' touching the trigger while outside it.
Inherited from TriggerOnce
Enable <void>
Enable this trigger.
Disable <void>
Disable this trigger, some trigger entities may also fire OnEndTouch when disabled.
Toggle <void>
Toggles this trigger between enabled and disabled states.
TouchTest <void>
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
StartTouch <void>
Fires the OnStartTouch output. If called by an entity inside the trigger, the OnStartTouch will be fired for them as the activator. Note that this input is passed even if the player is being treated as 'not' touching the trigger while inside it.
Inherited from BaseEntityBrush
Kill <void>
Removes this entity from the world.
KillHierarchy <void>
Removes this entity and all its children from the world.
SetParent <target_destination>
Changes the entity's parent in the movement hierarchy.
SetParentAttachment <string>
Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
SetParentAttachmentMaintainOffset <string>
Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.
ClearParent <void>
Removes this entity from the the movement hierarchy, leaving it free to move independently.
SetLocalAngles <vector>
Sets the rotation of the entity relative to the parent's rotation.
SetLocalOrigin <vector>
Sets the position of the entity relative to its parent if one exists. Otherwise relative to the world.
SetAbsAngles <vector>
Set this entity's angles, always relative to the world origin.
AddOutput <string>
Adds an entity I/O connection to this entity or changes keyvalues dynamically. Format: '<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite, 1 = only once)>' or 'keyvalue newval'. Very dangerous, use with care.
FireUser1 <void>
Causes this entity's OnUser1 output to be fired.
FireUser2 <void>
Causes this entity's OnUser2 output to be fired.
FireUser3 <void>
Causes this entity's OnUser3 output to be fired.
FireUser4 <void>
Causes this entity's OnUser4 output to be fired.
Use <void>
More or less replicates the player interacting with an entity. (+USE)
PassUser1 <string>
Causes this entity's OutUser1 output to be fired, passing along the parameter unchanged.
PassUser2 <string>
Causes this entity's OutUser2 output to be fired, passing along the parameter unchanged.
PassUser3 <string>
Causes this entity's OutUser3 output to be fired, passing along the parameter unchanged.
PassUser4 <string>
Causes this entity's OutUser4 output to be fired, passing along the parameter unchanged.
FireRandomUser <void>
Fires OnUser1, OnUser2, OnUser3, or OnUser4 with a 25% chance of each.
PassRandomUser <string>
Fires OutUser1, OutUser2, OutUser3, or OutUser4 with a 25% chance of each. The parameter is passed along unchanged.
KillIfNotVisible <void>
Removes this entity if it is not in the player's viewcone.
KillWhenNotVisible <void>
Removes this entity when it is not in the player's viewcone.
FireOutput <string>
Fires the named output on this entity. Format: '<output name>:<activator>:<caller>:<parameter>:<delay>' (OnDeath:hl3cardgame:gaben). Everything beyond the output name is optional.
RemoveOutput <string>
Removes all instances of the named output on this entity. Wildcards are supported, meaning you could just pass '*' to wipe all outputs from this entity.
AcceptInput <string>
Fires the named input on this entity. Format: '<input name>:<parameter>:<activator>:<caller>:<output ID>' (SetTarget:cheese). Everything beyond the input name is optional. Mind the fact this is arranged differently from FireOutput, having the parameter right after the input name.
CancelPending <void>
Cancels any events fired by this entity that are currently pending in the I/O event queue.
FreeChildren <void>
Unparents all direct children of this entity.
SetLocalVelocity <vector>
Sets this entity's current velocity.
SetLocalAngularVelocity <vector>
Sets this entity's current angular velocity.
AddSpawnFlags <integer>
Adds spawnflag(s) to this entity. Many spawnflags have their respective numbers suffixed in this FGD.
RemoveSpawnFlags <integer>
Removes spawnflag(s) to this entity. Many spawnflags have their respective numbers suffixed in this FGD.
AddSolidFlags <integer>
Adds solid flags to this entity.
RemoveSolidFlags <integer>
Removes solid flags from this entity.
ChangeVariable <string>
Similar to AddOutput, except it changes an internal variable similar to logic_datadesc_accessor instead. Very dangerous, use with care.
SetHealth <integer>
Sets this entity's health.
AddHealth <integer>
Adds to this entity's health.
RemoveHealth <integer>
Removes from this entity's health.
SetMaxHealth <integer>
Sets this entity's max health.
SetEntityName <target_destination>
Sets this entity's name that other entities should refer to it by.
SetTarget <target_destination>
Sets this entity's target. This is specific to certain entities, particularly logic entities that involve a target.
SetOwnerEntity <target_destination>
Sets this entity's owner entity. This has nothing to do with parenting and has more to do with collision and kill credits.
SetThinkNull <void>
Sets this entity's general think function to null. Behavior varies from entity to entity..
Touch <target_destination>
Simulates this entity touching the specified entity.
Outputs
OnRemove <void>
Fired whenever an entity is removed.
Inherited from Trigger
OnStartTouchAll <void>
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.
OnEndTouch <void>
Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire.
OnEndTouchAll <void>
Fires when an entity stops touching this trigger, and no other entities are touching it. Only entities that passed this trigger's filters are considered.
OnJump <void>
Fires when a player jumps in this trigger. Only entities that passed this trigger's filters are considered.
OnLand <void>
Fires when a player lands in this trigger. Only entities that passed this trigger's filters are considered.
Inherited from TriggerOnce
OnTrigger <void>
Fired whenever the trigger is activated.
OnStartTouch <void>
Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire.
OnTouching <void>
Fired when the TouchTest input is called, and an entity is touching this. Does not call activators.
OnNotTouching <void>
Fired when the TouchTest input is called, and no entity is touching this. Does not call activators.
Inherited from BaseEntityBrush
OnUser1 <void>
Fired in response to FireUser1 input.
OnUser2 <void>
Fired in response to FireUser2 input.
OnUser3 <void>
Fired in response to FireUser3 input.
OnUser4 <void>
Fired in response to FireUser4 input.
OutUser1 <string>
Fires in response to PassUser1 input, with the parameter passed through unchanged.
OutUser2 <string>
Fires in response to PassUser2 input, with the parameter passed through unchanged.
OutUser3 <string>
Fires in response to PassUser3 input, with the parameter passed through unchanged.
OutUser4 <string>
Fires in response to PassUser4 input, with the parameter passed through unchanged.