GetCompassTargets
From GECK
A function added by the ShowOff NVSE Plugin version 1.50.
Contents
Description
Returns an array containing player's compass targets. Includes either all of them (default, includeWhat = 0), or optionally only hostile actors (includeWhat = 1), or only detected actors (includeWhat = 2).
Syntax
(actors:array) GetCompassTargets includeWhat:int{0/1/2}
Example
array_var aTargets = GetCompassTargets 1 ; array will contain all hostile compass targets
Notes
- This function was originally included in the JohnnyGuitar NVSE Plugin, but it has been since moved to ShowOff.
- During the transition, the function lost its skipInvisible arg, as that is now always being accounted for; all targets that actually appear in the compass are considered.
Bugs
- This function can sometimes return invalid forms, although this may only happen on some machines. The reason is unknown.
