Trigger brush: Difference between revisions
Jump to navigation
Jump to search
Code:In code, it is represented by the
m (modernized templates used) |
m (grammar) |
||
| Line 2: | Line 2: | ||
{{ent not in fgd}} | {{ent not in fgd}} | ||
{{CD|CTriggerBrush|file1=modelentities.cpp}} | {{CD|CTriggerBrush|file1=modelentities.cpp}} | ||
{{entity|trigger_brush|type=e2}} Deprecated entity during the development of Half-Life 2, | {{entity|trigger_brush|type=e2}} Deprecated entity during the development of Half-Life 2, its sole difference compared to other entities is that a <code>OnUse</code> output exists. | ||
{{ModernNote|The brush ''is'' fully solid unlike other trigger [[entities]].}} {{ModernNote|Use [[func_button]] instead, it behaves like trigger_brush but is more likely to work on any version of source.}} | {{ModernNote|The brush ''is'' fully solid unlike other trigger [[entities]].}} {{ModernNote|Use [[func_button]] instead, it behaves like trigger_brush but is more likely to work on any version of source.}} | ||
{{ModernNote|The player events (such as <code>game_playerdie</code>) are | {{ModernNote|The player events (such as <code>game_playerdie</code>) 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.}} | ||
{{ModernCodenote|In code, it is represented by the <code>CTriggerBrush</code> class, defined in the <code>modelentities.cpp</code> file.}} | {{ModernCodenote|In code, it is represented by the <code>CTriggerBrush</code> class, defined in the <code>modelentities.cpp</code> file.}} | ||
Revision as of 09:13, 12 September 2023
This entity is obsolete. Its use is discouraged. It may only exist/function in older engine branches.
 Class hierarchy
|
|---|
| CTriggerBrush |
| modelentities.cpp
|
Template:Entity Deprecated entity during the development of Half-Life 2, its sole difference compared to other entities is that a OnUse output exists.
Template:ModernNote Template:ModernNote
Template:ModernNote
Code: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.
parentnameortarget).
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
Useinput 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."
]