Background for Starfield
Member of the Game script
ObjectReferencefunctionFindClosestReferenceOfTypeFromRef(FormarBaseObject, ObjectReferencearCenter, floatafRadius)Global

Description

Wiki Description

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

Documentation Comment

Finds the closest reference of a given base object within a given radius of a reference


Caveats

CK Wiki - 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.

Parameters

  1. FormarBaseObject

    CK Wiki Description

    The type of base object to look for

  2. ObjectReferencearCenter

    CK Wiki Description

    ObjectReference to use as a center to search from

  3. floatafRadius

    CK Wiki Description

    Maximum distance from center to look for a ObjectReference


Examples

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

Auto-Generated Example

Form myForm__arBaseObject
ObjectReference myObjectReference__arCenter
float myFloat__afRadius

ObjectReference returnedValue = Game.FindClosestReferenceOfTypeFromRef(myForm__arBaseObject, myObjectReference__arCenter, myFloat__afRadius)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.