trigger_brush
This entity is Obsolete. Its use is discouraged, and it may only exist/function in older engine branches.
class hierarchy |
---|
CTriggerBrush defined in modelentities.cpp
|
trigger_brush
is a brush entity available in all Source games. Deprecated entity during the development of Half-Life 2, its sole difference compared to other entities is that a OnUse
output exists.
Note:The brush is fully solid unlike other trigger entities.
Note:Use func_button instead, it behaves like trigger_brush but is more likely to work on any version of source.
Note:The player events (such as
game_playerdie
) are usable by all entities and not just by this entity, despite common misconception. The list of those is now available on the Targetname page.Code:In code, it is represented by the
CTriggerBrush
class, defined in the modelentities.cpp
file.Contents
Keyvalues
- Ignore flags
(InputFilter)
<integer> - Flags of things to ignore: players = 1, npcs = 2, pushables = 4, touch = 8, use = 16, all = 32
- Don't alert parent
(DontMessageParent)
<boolean> - Decides whether to forward OnStartTouch, OnEndTouch outputs or Use input to parented entity
Targetname:
- Name
(targetname)
<string> - The targetname that other entities refer to this entity by.
Inputs
EnableDisable:
Enable
Disable
- Enable/disable this entity from performing its task. It might also disappear from view.
Use
- Fires the OnUse output.
Outputs
OnUse
- Fired when the
Use
input is given.
OnStartTouch
- Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire.
OnEndTouch
- Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire.
FGD Code
@SolidClass base(Targetname, Parentname, Global, EnableDisable) = trigger_brush
[
InputFilter(integer) : "Ignore flags" : 0 : "Add up wanted flags of things to ignore: players = 1, npcs = 2, pushables = 4, touch = 8, use = 16, all = 32"
DontMessageParent(integer) : "Don't alert parent" : 0 : "When 0 forwards OnStartTouch, OnEndTouch outputs or Use input to parented entity"
input Use(void) : "Fires the OnUse output."
output OnUse(void) : "Fired when the Use input is given. "
output 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."
output OnEndTouch(void) : "Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire."
]