Mod:Creation Kit/IsNearPlayer - ObjectReference

Member of: Mod:Creation Kit/ObjectReference Script

A function that checks to see if this reference can be safely enabled/disabled/moved with confidence that the player won't see us messing around with the world.

Syntax
bool Function IsNearPlayer

Parameters
None.

Return Value
Whether this object is too close to the player to safely unload. Will err on the side of caution -- might return true in cases where you could monkey about with the object without the player seeing it, but will only return false if it is definitely safe to monkey with the object because the player will not see it.

Examples
if (!Box.IsNearPlayer) Box.Disable endif
 * Disable the box, but only if the player isn't nearby