sbrl-github/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-11-26 09:03:01 +00:00
Code Issues Releases Wiki Activity

safe_function: update docs, add todo ref implementing wea_core.safe_after()

Browse source
This commit is contained in:
Starbeamrainbowlabs 2024-10-17 02:40:07 +01:00
parent 6ea9a5acc8
commit 74377c7285
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
worldeditadditions_core/core/safe_function.lua
View file

@ -64,6 +64,12 @@ end
--- Calls the given function `fn` with the UNPACKED arguments from `args`, catching errors and sending the calling player a nice error message with a report link. --- Calls the given function `fn` with the UNPACKED arguments from `args`, catching errors and sending the calling player a nice error message with a report link.
-- --
-- WARNING: Do NOT nest `safe_function()` calls!!! -- WARNING: Do NOT nest `safe_function()` calls!!!
--
-- You do not need to call this function normally. For commands registered via `worldeditadditions_core.register_command`, your `parse()`, `nodes_needed()`, and `func()` functions are all protected with this function automatically.
--
-- You may need to call this function in an async function - NOT in the main `func()`, but inside every `minetest.after()` call. This is because an async jump like that provided by `minetest.after()` will cause the original function to end, thus ending the `safe_function()` sandbox.
--
-- TODO implement `wea_core.safe_after()`.
-- @param fn function The function to call -- @param fn function The function to call
-- @param args table The table of args to unpack and send to `fn` as arguments -- @param args table The table of args to unpack and send to `fn` as arguments
-- @param player_name string|nil The name of the player affected. If nil then no message is sent to the player. -- @param player_name string|nil The name of the player affected. If nil then no message is sent to the player.