Filter activator name

From Valve Developer Community
Revision as of 22:44, 6 January 2024 by Pee (talk | contribs) (Undo revision 369621 by PeeBot (talk))
Jump to navigation Jump to search
English (en)Translate (Translate)
C++ Class hierarchy
CFilterName
CBaseFilter
CLogicalEntity
CServerOnlyEntity
CBaseEntity
C++ filters.cpp

Template:Base point It is a filter that checks the targetname of the activator.

C++ In code, it is represented by theCFilterNameclass, defined in thefilters.cppfile.


Keyvalues

Filter Name (filtername) <targetname>
The name to filter by.
Note.pngNote:Entities without any targetname can be filtered by leaving the Filter Name blank.

BaseFilter:

Filter mode (Negated) <boolean>
Inverts the filter, making the specified criteria fail and all others pass.
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

BaseFilter:

TestActivator <variantRedirectInput/variant>
Tests the entity that called the input (the !activator) against the filter, and fires either the OnPass or OnFail output. (the parameter it takes is unused)
Icon-Bug.pngBug:Calling this input will cause the server to crash if the !activator entity no longer exists. Do not use this input to test any entities which may be asynchronously deleted, such as players or projectiles, or in an i/o chain which might be initiated by entity deletion, such as the OnEndTouch output of a trigger.

Outputs

BaseFilter:

OnPass
OnFail
!activator = activator of TestActivator input
!caller = this entity
One of these will fire when TestActivator input is sent, depending on if the activator is allowed by the filter or not.