FindClosestReferenceOfTypeFromRef - Game

From Creation Kit
Jump to: navigation, search

Member of: Game Script

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

Syntax

ObjectReference Function FindClosestReferenceOfTypeFromRef(Form arBaseObject, ObjectReference arCenter, float afRadius) global

Parameters

  • arBaseObject: The type of base object to look for
  • arCenter: Reference to use as a center to search from
  • afRadius: Maximum distance from center to look for a reference

Return Value

The closest reference found, none if none.

Examples

; Find the closest diamond reference to the player, limiting the search to 5 units
ObjectReference closestDiamond = Game.FindClosestReferenceOfTypeFromRef(Diamond, Game.GetPlayer(), 5.0)

Notes

  • if arBaseObject is the same type as arCenter, this function will return arCenter instead. In other words arCenter is not excluded from the the search.

See Also