SetLocked

From NWN Lexicon
Revision as of 13:17, 10 September 2012 by Dood (talk | contribs) (Remarks)
Jump to: navigation, search



SetLocked(object, int)

Locks or unlocks a door or placeable.

void SetLocked(
    object oTarget,
    int bLocked
);

Parameters

oTarget

The door or placeable to lock

bLocked

TRUE to lock, FALSE to unlock.


Description

Used by objects or creatures to set the locked status of an object or placeable without checking the Open Locks skill.

Note that DM Force Lock does the same thing as this. You can actually lock doors which cannot be normally re-locked, but it is not recommended.



Remarks

Alternatively, ActionLockObject and ActionUnlockObject can be used by creatures so appropriate skill checks are made. Make sure, as well, that your door has the 're-lockable' box checked.

You can lock an open door. If you do, it will be locked once it closes.

When the object is already (un)locked, the On(Un)locked event is still fired.


Version

1.61

Example

// Unlocked an object with the tag DOOR_TAG
void main()
{
    object oDoor = GetObjectByTag("DOOR_TAG");
    SetLocked(oDoor, FALSE);
}

See Also

functions: 

GetLastUnlocked



 author: Tom Cassiotis, editor: Jasperre