Difference between revisions of "FindClosestActorFromRef - Game"
Jump to navigation
Jump to search
imported>Imp of the Perverse |
imported>Cipscis (Added note about this object being able to return the player, and fixed the example to not pass the player (or another actor) as the center) |
||
| Line 20: | Line 20: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
; Find the closest actor to the player, limiting the search to 5 units | ; Find the closest actor to the player, limiting the search to 5 units | ||
Actor closest = Game.FindClosestActorFromRef( | Actor closest = Game.FindClosestActorFromRef(RefProperty, 5.0) | ||
</source> | </source> | ||
== Notes == | |||
* The player is an actor, so this function can return the player if they are the closest actor to arCenter. | |||
* If an actor is used as the center of this search, that actor's reference will always be the one returned by this function, so it cannot be used to find the closest actor to another actor, including the player. | |||
== See Also == | == See Also == | ||
Revision as of 17:01, 19 February 2012
Member of: Game Script
Finds the closest actor within a given radius of a reference.
Syntax
Actor Function FindClosestActorFromRef(ObjectReference arCenter, float afRadius) globalParameters
- arCenter: The reference to search around
- afRadius: Maximum distance from center to look for an actor
Return Value
The closest actor found, none if none. The reference provided for arCenter is not excluded from the search, limiting this function's usefulness somewhat. The example code, for example, would always return "player".
Examples
; Find the closest actor to the player, limiting the search to 5 units
Actor closest = Game.FindClosestActorFromRef(RefProperty, 5.0)Notes
- The player is an actor, so this function can return the player if they are the closest actor to arCenter.
- If an actor is used as the center of this search, that actor's reference will always be the one returned by this function, so it cannot be used to find the closest actor to another actor, including the player.