Interface Options ▾

Translation:
Language:

Lockable

IID: [1:{0100004B}]

This interface represents anything that is lockable.

> Type Definitions

LockStateType ID: 0

The lock state of the item. True means locked and false means unlocked.

Type: boolean

> Properties

isLockedItem ID: 3

This is the current lock state of the item.

Read: true
Write: false
Type: 0 -  LockState

> Methods

lockItem ID: 1


Lock the item. This may fail if not currently lockable. In that case, the Failed exception is thrown.
unlockItem ID: 2


Unlock the item. This may fail if the item is not currently unlockable. In that case, the Failed exception is thrown.

> Exceptions

failedItem ID: 4


This exception may occur when the item cannot be locked or unlocked.