ClearWorldDoorKey: Difference between revisions
Jump to navigation
Jump to search
Document upcoming 0.1.9 custom native keys, shared doors, server Lua callbacks and persistence; not a release |
Release 0.1.9 / BUILD264 / Protocol42: availability and download setup; preserve experimental limits |
||
| Line 1: | Line 1: | ||
= clearWorldDoorKey = | = clearWorldDoorKey = | ||
'''Available from 0.1.9 | '''Available from 0.1.9. Use matching updated server and clients.''' | ||
Server Lua. Part of [[Custom keys|custom keys and shared placed doors]]. | Server Lua. Part of [[Custom keys|custom keys and shared placed doors]]. | ||
Latest revision as of 13:26, 20 October 2026
clearWorldDoorKey
Available from 0.1.9. 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.