ClearWorldDoorKey

clearWorldDoorKey

Available from 0.1.9 (upcoming; not yet publicly released). Not included in public 0.1.8. Use matching updated server and clients.

Server Lua. Part of custom keys and shared placed doors.

Syntax

ok, error = clearWorldDoorKey(id)

Parameters and behavior

id identifies an owned placed door with a key assignment. Removes the custom key rule entirely. Does not remove the key definition or any copies, force a door closed, or delete the door.

Returns

true, empty error on success; false, error string when the owned rule/door is missing. Actual change queues onWorldDoorLockChange with empty new key and locked=false.

Examples and security

See Custom keys for complete registration, copy issuance, placement, persistence and callback examples. These are server functions, not client RPC endpoints. Do not forward untrusted client arguments without gameplay authorization.