FindClosestReferenceOfAnyTypeInList - Game

From the CreationKit Wiki
Revision as of 17:12, 18 October 2011 by imported>Jlundin (→‎Syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: Game Script

Finds the closest reference of any of the types in the list from the given location and within the given radius.

Syntax

ObjectReference Function FindClosestReferenceOfAnyTypeInList(FormList arBaseObjectsA, float afX, float afY, float afZ, \
  float afRadius) native global

Parameters

  • arBaseObjectsA: The list of valid base objects to look for
  • 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 a reference

Return Value

The closest reference of any of the types within the radius, none if none was found.

Examples

; Find the closest gem reference to 0,0,0, limiting the search to 5 units
ObjectReference closestGem = Game.FindClosestReferenceOfAnyTypeInList(GemList, 0.0, 0.0, 0.0, 5.0)

See Also