Editing Lock - ObjectReference

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

Locks or unlocks this object. If told to lock it, and no lock is attached, a very easy lock will be attached. If the object is open, and it is told to lock it, the object will be snapped closed.

== Syntax ==
<syntaxhighlight lang="papyrus">
Function Lock(bool abLock = true, bool abAsOwner = false) native
</syntaxhighlight>

== Parameters ==
*abLock: Whether to lock or unlock this lock.
**'''Default''': True
*abAsOwner: If true, and on a door, it will behave as if the owner unlocked or locked the door, and flag the adjoining cell as public or private as appropriate.
**'''Default''': False

== Return Value ==
None.

== Examples ==
<syntaxhighlight lang="papyrus">
; Lock the door
SecurityDoor.Lock();
</syntaxhighlight>
<br/>
<syntaxhighlight lang="papyrus">
; Unlock the door, flagging the cell on the other side as public
PrivateDoor.Lock(false, true)
</syntaxhighlight>

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

*[[Locking and Unlocking Doors]] tutorial.

*[[GetLockLevel - ObjectReference]]
*[[IsLocked - ObjectReference]]
*[[LockDoors (Procedure)]]
*[[SetLockLevel - ObjectReference]]
*[[UnlockDoors (Procedure)]]
*[[UnlockOwnedDoorsInCell - Actor]]

*[[GetLocked]] console command.
*[[GetLockLevel]] console command.
*[[Lock]] console command.
*[[Unlock]] console command.