IsFurnitureInUse - ObjectReference | Skyrim SE

Found in:

Vanilla
SKSE

boolfunctionIsFurnitureInUse(boolabIgnoreReserved=false)Native

Description

Wiki Description

Checks to see if any furniture marker on this object is in use, optionally ignoring markers that are reserved, but not currently used.

Documentation Comment

Is any marker on this furniture in use?

Caveats

CK Wiki - Notes

If the furniture object has no marker, or is being activated remotely so no animation plays, IsFurnitureInUse will return false. To workaround this, if the furniture disables looking controls (for example crafting stations), the below example can be used instead.

Event OnActivate(ObjectReference akActionRef)
    Utility.Wait(1.0)
    RegisterForSingleUpdate(0.5)
EndEvent

Event OnUpdate()
    if ( ! Game.IsLookingControlsEnabled() )
        ; Controls disabled, Player must still be using this furniture
        RegisterForSingleUpdate(0.5)
        return
    else
        ; Furniture no longer in use
    endif
EndEvent
Event OnActivate(ObjectReference akActionRef)
    Utility.Wait(1.0)
    RegisterForSingleUpdate(0.5)
EndEvent

Event OnUpdate()
    if ( ! Game.IsLookingControlsEnabled() )
        ; Controls disabled, Player must still be using this furniture
        RegisterForSingleUpdate(0.5)
        return
    else
        ; Furniture no longer in use
    endif
EndEvent

Parameters

boolabIgnoreReserved=false

CK Wiki Description

Whether to ignore reserved markers or not.

Default:False

Examples

; Is the bed in use (or someone has reserved it)?
if Bed.IsFurnitureInUse()
    Debug.Trace("Bed is being used")
endIf; Is the bed in use (or someone has reserved it)?
if Bed.IsFurnitureInUse()
    Debug.Trace("Bed is being used")
endIf

; Is the bed actually in use (ignoring reservations)?
if Bed.IsFurnitureInUse(true)
    Debug.Trace("Bed is actually being used")
endIf; Is the bed actually in use (ignoring reservations)?
if Bed.IsFurnitureInUse(true)
    Debug.Trace("Bed is actually being used")
endIf

Auto-Generated Example

bool myBool__abIgnoreReserved

bool returnedValue = myObjectReference__toCallFunctionOn.IsFurnitureInUse(myBool__abIgnoreReserved)

Additional References

View this function’s page on the Skyrim Creation Kit Wiki