Trigger brush

From Valve Developer Community
Revision as of 05:58, 20 April 2023 by JustBluu (talk | contribs) (modernized templates used)
Jump to navigation Jump to search
Obsolete-notext.png
This entity is obsolete. Its use is discouraged. It may only exist/function in older engine branches.
Icon-NotInFGD.png
This entity is not in the FGD by default.
See below for instructions on making it available.
C++ Class hierarchy
CTriggerBrush
CBaseEntity
C++ modelentities.cpp

Template:Entity Deprecated entity during the development of Half-Life 2, it's sole difference compared to other entities is that a OnUse output exists. Template:ModernNote Template:ModernNote Template:ModernNote

Cpp.pngCode:In code, it is represented by the CTriggerBrush class, defined in the modelentities.cpp file.

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

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."
]


See also