oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-06-27 16:36:03 +00:00
Code Wiki Activity

doc

Browse source
This commit is contained in:
y5nw 2025-02-22 23:01:44 +01:00
parent 54b14c6c62
commit 9db64d5834
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/lua_api.md
View file

@ -7653,12 +7653,18 @@ Misc.
* `core.global_exists(name)` * `core.global_exists(name)`
* Checks if a global variable has been set, without triggering a warning. * Checks if a global variable has been set, without triggering a warning.
* `core.register_portable_metatable(name, mt)`: * `core.register_portable_metatable(name, mt, serializer, deserializer)`:
* Register a metatable that should be preserved when Lua data is transferred * Register a metatable that should be preserved when Lua data is transferred
between environments (via IPC, `handle_async`, or `core.serialize`). between environments (via IPC, `handle_async`, or `core.serialize`).
* `name` is a string that identifies the metatable. It is recommended to * `name` is a string that identifies the metatable. It is recommended to
follow the `modname:name` convention for this identifier. follow the `modname:name` convention for this identifier.
* `mt` is the metatable to register. * `mt` is the metatable to register.
* `serializer` is a function used by `core.serialize` to serialize data with
the given metatable. It may return multiple values, but the return values should not
contain the input datum unless `serializer` is the identity function. The default
value for `serializer` is the identity function.
* `deserializer` is a function used by `core.deserialize` to deserialize data from
values returned by `serializer`. The default value is a wrapper around `setmetatable`.
* Note that the same metatable can be registered under multiple names, * Note that the same metatable can be registered under multiple names,
but multiple metatables must not be registered under the same name. but multiple metatables must not be registered under the same name.
* You must register the metatable in both the main environment * You must register the metatable in both the main environment