Difference between revisions of "GetDetectedActors"

729 bytes removed ,  06:26, 25 October 2015
no edit summary
imported>Jazzisparis
(Created page with "{{Function |origin = JIP |summary = Returns an '''array_var''' containing all actors currently detected, in some level, by the calling actor. The optional <i>filter</i> para...")
 
imported>Jazzisparis
 
Line 1: Line 1:
{{Function
{{Function
  |origin = JIP
  |origin = JIP
  |summary = Returns an '''array_var''' containing all actors currently detected, in some level, by the calling actor. The optional <i>filter</i> parameter may be used for specifying actors in which level(s) of detection are returned.
  |summary = Returns an '''array_var''' containing all actors currently '''detected''' by the calling actor.
  |name = GetDetectedActors
  |name = GetDetectedActors
  |returnType = detectedActors:array_var
  |returnType = detectedActors:array_var
  |referenceType = reference
  |referenceType = reference
|arguments =
  |example = let aDetected := actorRef.GetDetectedActors
  {{FunctionArgument
  |Name = filter
  |Type = int
  |Optional = y
  }}
==Detection-Level Filter Values==
<pre>1&#09;Unseen (corresponds to "Caution")
2&#09;Noticed (corresponds to "Danger")
4&#09;Seen (corresponds to flashing "Danger")</pre>
  |example = <pre>let aDetected := actorRef.GetDetectedActors</pre>
Will return all actors currently detected -- in any level -- by <i>actorRef</i>.
<pre>let aDetected := actorRef.GetDetectedActors 1</pre>
Will return all actors currently "Unseen" by <i>actorRef</i>.
<pre>let aDetected := actorRef.GetDetectedActors 6</pre>
Will return all actors currently "Noticed" or "Seen" by <i>actorRef</i>.
}}
}}
==See Also==
==See Also==
Anonymous user