FindClosestActor - Game

Member of: Game Script

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

Syntax

Actor Function FindClosestActor(float afX, float afY, float afZ, float afRadius) native global

Parameters

• afX: center of the search, X component
• afY: center of the search, Y component
• afZ: center of the search, Z component
• afRadius: Maximum distance from center to look for an actor

Return Value

The closest actor found, none if none.

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)

Notes

• Works as expected, however if the coordinates provided are from an actor(using the getpositionXYZ) with no offsets, the return value will be that of the actor. In other words, the closest actor at that's actor's position will be the actor itself.

See Also

• Game Script
• FindClosestActorFromRef - Game
• FindRandomActor - Game
• FindRandomActorFromRef - Game