Difference between revisions of "IsOffLimits - ObjectReference"
Jump to navigation
Jump to search
(→Syntax) |
DavidJCobb (talk | contribs) (i took a brief look at TESObjectREFR::IsOffLimits in a disassembler, though i didn't dig too deeply. spent maybe 30 minutes to an hour looking at it.) |
||
| (5 intermediate revisions by one other user not shown) | |||
| Line 4: | Line 4: | ||
'''SKSE Member of:''' [[ObjectReference Script]] | '''SKSE Member of:''' [[ObjectReference Script]] | ||
This | 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 == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Bool Function IsOffLimits() | Bool Function IsOffLimits() Native | ||
</source> | </source> | ||
== Examples == | == Examples == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
ObjectReference | ObjectReference ErikursBooze boozeRef Auto | ||
Function | Function takeButDontSteal() | ||
If !boozeRef.IsOffLimits() | |||
boozeRef.Activate(playerRef) ; takes it | |||
EndIf | |||
EndFunction | EndFunction | ||
</source> | </source> | ||
== Notes == | == Notes == | ||
* This function | * 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 == | == See Also == | ||
*[[ObjectReference Script]] | *[[ObjectReference Script]] | ||
Latest revision as of 18:14, 10 April 2022
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[edit | edit source]
Bool Function IsOffLimits() NativeExamples[edit | edit source]
ObjectReference ErikursBooze boozeRef Auto
Function takeButDontSteal()
If !boozeRef.IsOffLimits()
boozeRef.Activate(playerRef) ; takes it
EndIf
EndFunctionNotes[edit | edit source]
- This function will always return false for any furniture that is not a bed.
- This function runs special-case checks for doors. 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.