SetWorldDoorKey: 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: | ||
= setWorldDoorKey = | = setWorldDoorKey = | ||
'''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:29, 20 October 2026
setWorldDoorKey
Available from 0.1.9. Use matching updated server and clients.
Server Lua. Part of custom keys and shared placed doors.
Syntax
ok, error = setWorldDoorKey(id, item)
Parameters and behavior
id identifies an owned placed door. item is an active canonical custom key from this or another resource. Assigns the key and enables its lock. One key type can open multiple doors; at least one authoritative copy is required and is not consumed.
Returns
true, empty error on success; false, error string otherwise. Locking does not close an open door. An actual rule change queues onWorldDoorLockChange.
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.