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

weac.notify: fix __call

Browse source 
When you do weac.notify(player_name, "info", "msg"), Lua auto-inserts a `self` table which refers to the main `Notify` table there.

This is because `local function call()` is registered via `setmetatable(Notify, ...)`, which auto-inserts `self` as the 1st argument.

To this end, this command adds a dummy 1st argument `_self` to capture this extra table to avoid all args being shifted by 1.
This commit is contained in:
Starbeamrainbowlabs 2024-10-17 00:21:42 +01:00
parent 547cdb943a
commit 36a6bf6b49
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
worldeditadditions_core/utils/notify/notify.lua
View file

@ -60,11 +60,14 @@ end
--- Send a notification of type `ntype` (for metatable). --- Send a notification of type `ntype` (for metatable).
-- (Same as `Notify[ntype](name, message)`) -- (Same as `Notify[ntype](name, message)`)
-- @param string name The name of the player to send the notification to. -- @param table _self Provided automatically by Lua. You do not need to set this automatically - see example.
-- @param string ntype The type of notification. -- @param string name The name of the player to send the notification to.
-- @param string message The message to send. -- @param string ntype The type of notification.
-- @param string message The message to send.
-- @return table The Notify instance. -- @return table The Notify instance.
local call = function(name, ntype, message) -- @example Basic usage
-- worldeditadditions_core.notify(player_name, "info", "All registered commands:\n....")
local call = function(_self, name, ntype, message)
if ntype ~= "__call" and not Notify[ntype] then if ntype ~= "__call" and not Notify[ntype] then
Notify.error(name, "Invalid notification type: " .. ntype) Notify.error(name, "Invalid notification type: " .. ntype)
Notify.error(name, "Message: " .. message) Notify.error(name, "Message: " .. message)
@ -83,7 +86,7 @@ setmetatable(Notify, {__call = call})
-- @param string? colour Optional. The colour of the notification. -- @param string? colour Optional. The colour of the notification.
-- @param boolean? message_coloured Optional. Whether the message should be coloured. -- @param boolean? message_coloured Optional. Whether the message should be coloured.
-- @return boolean True if all parameters are valid, false otherwise. -- @return boolean True if all parameters are valid, false otherwise.
-- @example Predefined notification types -- @example Custom notification types
-- Notify.custom(name, "custom", "This one is magenta!", "#FF00FF", true) -- Notify.custom(name, "custom", "This one is magenta!", "#FF00FF", true)
-- Notify.custom(name, "custom", "This one is gold with white text!", "#FFC700") -- Notify.custom(name, "custom", "This one is gold with white text!", "#FFC700")
function Notify.custom(name, ntype, message, colour, message_coloured) function Notify.custom(name, ntype, message, colour, message_coloured)