Editing IsOffLimits - ObjectReference

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:SKSE]]
'''SKSE Member of:''' [[ObjectReference Script]]

This Papyrus function provides access to one of the internal game engine functions that Skyrim's UI uses to determine whether interacting with some object may be a crime. It's one of the functions that the game engine calls when it wants to know whether to override an object's activation prompt with "Steal" or "Steal from," for example.

== Syntax ==
<syntaxhighlight lang="papyrus">
Bool Function IsOffLimits() Native
</syntaxhighlight>

== Examples ==

<syntaxhighlight lang="papyrus">
ObjectReference ErikursBooze boozeRef  Auto  

Function takeButDontSteal()
	If !boozeRef.IsOffLimits()
		boozeRef.Activate(playerRef) ; takes it
	EndIf
EndFunction
</syntaxhighlight>

== Notes ==
* This function will always return false for any [[furniture]] that is not a bed.
* This function runs special-case checks for [[door]]s. As of this writing, these checks have not been reverse-engineered in detail, but may include things like ownership checks for the cell that the door leads to.
* In all other cases, this function runs typical ownership checks, which include things like "is this object owned by a [[Faction]] that the player is a member of, with the player's faction rank high enough to grant ownership?"
* This function is coded to run special-case checks when called on an [[actor]] while the player is sneaking. However, these checks are exactly identical to the normal checks run for most objects.

== See Also ==
*[[ObjectReference Script]]