Point entity finder: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Replaced OutEntity with OnFoundEntity, and added a description to the Search Method keyvalue, and a few other minor things.)
m (Changed format of some sections ;Removed obsolete templates (this is a neat entity))
Line 1: Line 1:
{{base point|point_entity_finder|since=Left 4 Dead}}
{{base point|point_entity_finder|since=Left 4 Dead}} When given the<code>FindEntity</code>input, it finds an appropriate entity based on the given criterias, and pass the result as the{{ent|!caller}}in the<code>OnFoundEntity</code>output.
 
== Entity description ==
An entity that will find an entity and pass it along as the [[!caller]] with the <code>OnFoundEntity</code> output.


== Keyvalues ==
== Keyvalues ==
{{KV|Filter Name|filterclass|Filter to use to narrow set of find-able entities. See [[filter_activator_name]] for more explanation.}}
{{KV|Filter Name|filterclass|Filter to use to narrow set of find-able entities. See [[filter_activator_name]] for more explanation.}}
{{KV|Reference Entity|target_destination|Name of the entity to use when evaluating criteria.  If left blank, the entity will use itself.}}
{{KV|Reference Entity|target_destination|Name of the entity to use for search method distance comparisons.  If left blank, the entity will use itself.}}
{{KV|Search Method|choices|After filtering down the entities to find, if there are multiple entities that it has found, this determines which entity gets sent as the [[!caller]].}}
{{KV|Search Method|choices|After filtering down the entities to find, if there are multiple valid candidates, this determines which entity gets sent under the{{ent|!caller}}name.
* 0 : Nearest
:* 0 : Nearest
* 1 : Farthest
:* 1 : Farthest
* 2 : Random
:* 2 : Random
{{KV Targetname}}
}}
{{KV BaseEntity|base=1}}


== Inputs ==
== Inputs ==
{{IO|FindEntity|Find an entity that meets the specified criteria. Will fire <code>OnFoundEntity</code> output and pass the entity as the [[!caller]].}}
{{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 Targetname}}
{{I BaseEntity|base=1}}


== Outputs ==
== Outputs ==
{{IO|OnFoundEntity|Fired when <code>FindEntity</code> input was sent and a entity was found. Passes the found entity as the [[!caller]].}}
{{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 Targetname}}
{{O BaseEntity|l4d=1}}

Revision as of 13:37, 17 May 2021

Template:Base point When given theFindEntityinput, it finds an appropriate entity based on the given criterias, and pass the result as the!callerin theOnFoundEntityoutput.

Keyvalues

Filter Name ([todo internal name (i)]) <filter>
Filter to use to narrow set of find-able entities. See filter_activator_name for more explanation.
Reference Entity ([todo internal name (i)]) <targetname>
Name of the entity to use for search method distance comparisons. If left blank, the entity will use itself.
Search Method ([todo internal name (i)]) <choices>
After filtering down the entities to find, if there are multiple valid candidates, this determines which entity gets sent under the!callername.
  • 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!callername.


Outputs

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