Difference between revisions of "GetDetectingActors"

From GECK

(Created page with "{{Function |origin = JIP |summary = Returns an '''array_var''' containing all actors currently detecting, in some level, the calling actor. The optional <i>filter</i> parame...")
 
 
Line 1: Line 1:
 
{{Function
 
{{Function
 
  |origin = JIP
 
  |origin = JIP
  |summary = Returns an '''array_var''' containing all actors currently detecting, in some level, the calling actor. The optional <i>filter</i> parameter may be used for specifying level(s) of detection.
+
  |summary = Returns an '''array_var''' containing all actors currently '''detecting''' the calling actor.
 
  |name = GetDetectingActors
 
  |name = GetDetectingActors
 
  |returnType = detectingActors:array_var
 
  |returnType = detectingActors:array_var
 
  |referenceType = reference
 
  |referenceType = reference
|arguments =
+
  |example = let aDetecting := actorRef.GetDetectingActors
  {{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 aDetecting := actorRef.GetDetectingActors</pre>
+
Will return all actors by which <i>actorRef</i> is currently detected in <u>any</u> level.
+
<pre>let aDetecting := actorRef.GetDetectingActors 1</pre>
+
Will return all actors by which <i>actorRef</i> is currently "Unseen".
+
<pre>let aDetecting := actorRef.GetDetectingActors 6</pre>
+
Will return all actors by which <i>actorRef</i> is currently "Noticed" or "Seen".
+
 
}}
 
}}
 
==See Also==
 
==See Also==

Latest revision as of 07:24, 25 October 2015

A function added by the JIP NVSE Plugin.

Description

Returns an array_var containing all actors currently detecting the calling actor.

Syntax

(detectingActors:array_var) reference.GetDetectingActors

Example

let aDetecting := actorRef.GetDetectingActors

See Also

Personal tools