FindClosestReferenceOfType - Game

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: Game Script

Finds the closest reference of the given type from the given location and within the given radius.

Syntax[edit | edit source]

ObjectReference Function FindClosestReferenceOfType(Form arBaseObject, float afX, float afY, float afZ, float afRadius) native global

Parameters[edit | edit source]

  • arBaseObject: The type of base object 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[edit | edit source]

The closest reference found, none if none.

Examples[edit | edit source]

; Find the closest diamond reference to 0,0,0, limiting the search to 5 units
ObjectReference closestDiamond = Game.FindClosestReferenceOfType(Diamond, 0.0, 0.0, 0.0, 5.0)

See Also[edit | edit source]