Background for Skyrim SE
Member of the Game script
ActorfunctionFindClosestActor(floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

Description

Wiki Description

Finds the closest Actor within a given radius of a location.

Documentation Comment

Finds the closest actor within a given radius of a location


Caveats

CK Wiki - Notes

  • The player is an actor, so this function can return the player if they are the closest actor to the passed coordinates.

Parameters

floatafX

CK Wiki Description

center of the search, X component

floatafY

CK Wiki Description

center of the search, Y component

floatafZ

CK Wiki Description

center of the search, Z component

floatafRadius

CK Wiki Description

Maximum distance from center to look for an Actor


Examples

; Find the closest actor to 0,0,0, limiting the search to 5 units
Actor closest = Game.FindClosestActor(0.0, 0.0, 0.0, 5.0)

Auto-Generated Example

float myFloat__afX
float myFloat__afY
float myFloat__afZ
float myFloat__afRadius

Actor returnedValue = Game.FindClosestActor(myFloat__afX, myFloat__afY, myFloat__afZ, myFloat__afRadius)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.