This article's documentation is for anything that uses the Source engine. Click here for more information.

Point entity finder: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Also in Garry's Mod (circa 14 March 2025))
No edit summary
Line 1: Line 1:
{{CD|CPointEntityFinder|file1=point_entity_finder.cpp}}
{{CD|CPointEntityFinder|file1=point_entity_finder.cpp}}
{{this is a|point entity|name=point_entity_finder|since=Left 4 Dead}} {{also|{{mapbase}}{{gmod}}}} When given the <code>FindEntity</code> input, it finds an appropriate entity based on the given criteria, and pass the result as the {{ent|!caller}} in the <code>OnFoundEntity</code> output.
{{This is a|point entity|name=point_entity_finder|since=Left 4 Dead}} {{also|{{mapbase}}{{gmod}}}} When given the <code>FindEntity</code> input, it finds an appropriate entity based on the given criteria, and pass the result as the {{ent|!caller}} in the <code>OnFoundEntity</code> output.


== Keyvalues ==
== Keyvalues ==
{{KV Targetname}}
{{KV|Filter Name|intn=filtername|filterclass|Filter to use to narrow set of find-able entities. See [[filter_activator_name]] for more explanation.}}
{{KV|Filter Name|intn=filtername|filterclass|Filter to use to narrow set of find-able entities. See [[filter_activator_name]] for more explanation.}}
{{KV|Reference Entity|intn=referencename|target_destination|Name of the entity to use for search method distance comparisons.  If left blank, the entity will use itself.}}
{{KV|Reference Entity|intn=referencename|target_destination|Name of the entity to use for search method distance comparisons.  If left blank, the entity will use itself.}}
Line 10: Line 11:
:* 2 : Random
:* 2 : Random
}}
}}
{{KV Targetname}}


== Inputs ==
== Inputs ==
{{IO|FindEntity|Start a search on an entity that meets the specified criteria. Fires the<code>OnFoundEntity</code>output and pass the found entity under the {{ent|!caller}} name.}}
{{I|FindEntity|Start a search on an entity that meets the specified criteria. Fires the<code>OnFoundEntity</code>output and pass the found entity under the {{ent|!caller}} name.}}


== Outputs ==
== Outputs ==
{{IO|OnFoundEntity|When a search from the<code>FindEntity</code>input found a valid entity. The found entity is passed under the {{ent|!caller}} name.}}
{{O|OnFoundEntity|When a search from the<code>FindEntity</code>input found a valid entity. The found entity is passed under the {{ent|!caller}} name.}}


[[Category:Mapbase entities]]
[[Category:Mapbase entities]]
[[Category:Mapbase point entities]]
[[Category:Mapbase point entities]]
== See also ==
* [[Left 4 Dead 2/Scripting/Script Functions#CEntities]]
* [[Team Fortress 2/Scripting/Script Functions#CEntities]]

Revision as of 18:26, 6 April 2025

C++ Class hierarchy
CPointEntityFinder
CBaseEntity
C++ point_entity_finder.cpp

point_entity_finder is a point entity available in all Source Source games since Left 4 Dead Left 4 Dead. (also in MapbaseGarry's Mod) When given the FindEntity input, it finds an appropriate entity based on the given criteria, and pass the result as the !caller in the OnFoundEntity output.

Keyvalues

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

Filter Name (filtername) <filter>
Filter to use to narrow set of find-able entities. See filter_activator_name for more explanation.
Reference Entity (referencename) <targetname>
Name of the entity to use for search method distance comparisons. If left blank, the entity will use itself.
Search Method (Method) <choices>
After filtering down the entities to find, if there are multiple valid candidates, this determines which entity gets sent under the !caller name.
  • 0 : Nearest
  • 1 : Farthest
  • 2 : Random

Inputs

FindEntity
Start a search on an entity that meets the specified criteria. Fires theOnFoundEntityoutput and pass the found entity under the !caller name.

Outputs

OnFoundEntity
When a search from theFindEntityinput found a valid entity. The found entity is passed under the !caller name.

See also