From 44495ea719b98aca341b9082521d0d4ee51405c8 Mon Sep 17 00:00:00 2001 From: DS Date: Fri, 9 Jun 2017 15:48:04 +0200 Subject: [PATCH] CSM: Fix documentation error for register_on_*_chat_messages (#5917) --- builtin/client/chatcommands.lua | 2 +- builtin/client/register.lua | 4 ++-- clientmods/preview/init.lua | 5 ++--- doc/client_lua_api.md | 6 +++--- src/script/cpp_api/s_client.cpp | 4 ++-- 5 files changed, 10 insertions(+), 11 deletions(-) diff --git a/builtin/client/chatcommands.lua b/builtin/client/chatcommands.lua index 2b8cc4acd..ed43a6140 100644 --- a/builtin/client/chatcommands.lua +++ b/builtin/client/chatcommands.lua @@ -1,7 +1,7 @@ -- Minetest: builtin/client/chatcommands.lua -core.register_on_sending_chat_messages(function(message) +core.register_on_sending_chat_message(function(message) if message:sub(1,2) == ".." then return false end diff --git a/builtin/client/register.lua b/builtin/client/register.lua index 6b12ddec8..cfc5abaa7 100644 --- a/builtin/client/register.lua +++ b/builtin/client/register.lua @@ -61,8 +61,8 @@ end core.registered_globalsteps, core.register_globalstep = make_registration() core.registered_on_shutdown, core.register_on_shutdown = make_registration() core.registered_on_connect, core.register_on_connect = make_registration() -core.registered_on_receiving_chat_messages, core.register_on_receiving_chat_messages = make_registration() -core.registered_on_sending_chat_messages, core.register_on_sending_chat_messages = make_registration() +core.registered_on_receiving_chat_message, core.register_on_receiving_chat_message = make_registration() +core.registered_on_sending_chat_message, core.register_on_sending_chat_message = make_registration() core.registered_on_death, core.register_on_death = make_registration() core.registered_on_hp_modification, core.register_on_hp_modification = make_registration() core.registered_on_damage_taken, core.register_on_damage_taken = make_registration() diff --git a/clientmods/preview/init.lua b/clientmods/preview/init.lua index 073ea11db..809e4f017 100644 --- a/clientmods/preview/init.lua +++ b/clientmods/preview/init.lua @@ -30,13 +30,13 @@ core.register_on_item_use(function(itemstack, pointed_thing) end) -- This is an example function to ensure it's working properly, should be removed before merge -core.register_on_receiving_chat_messages(function(message) +core.register_on_receiving_chat_message(function(message) print("[PREVIEW] Received message " .. message) return false end) -- This is an example function to ensure it's working properly, should be removed before merge -core.register_on_sending_chat_messages(function(message) +core.register_on_sending_chat_message(function(message) print("[PREVIEW] Sending message " .. message) return false end) @@ -155,4 +155,3 @@ core.register_chatcommand("privs", { return true, core.privs_to_string(minetest.get_privilege_list()) end, }) - diff --git a/doc/client_lua_api.md b/doc/client_lua_api.md index 42d2bfbbf..43b33ac97 100644 --- a/doc/client_lua_api.md +++ b/doc/client_lua_api.md @@ -648,10 +648,10 @@ Call these functions only at load time! semi-frequent intervals as well as on server shutdown. * `minetest.register_on_connect(func())` * Called at the end of client connection (when player is loaded onto map) -* `minetest.register_on_receiving_chat_message(func(name, message))` +* `minetest.register_on_receiving_chat_message(func(message))` * Called always when a client receive a message * Return `true` to mark the message as handled, which means that it will not be shown to chat -* `minetest.register_on_sending_chat_message(func(name, message))` +* `minetest.register_on_sending_chat_message(func(message))` * Called always when a client send a message from chat * Return `true` to mark the message as handled, which means that it will not be sent to server * `minetest.register_chatcommand(cmd, chatcommand definition)` @@ -676,7 +676,7 @@ Call these functions only at load time! * Called when the local player punches a node * Newest functions are called first * If any function returns true, the punch is ignored -* `minetest.register_on_placenode(function(pointed_thing, node))` +* `minetest.register_on_placenode(function(pointed_thing, node))` * Called when a node has been placed * `minetest.register_on_item_use(func(item, pointed_thing))` * Called when the local player uses an item. diff --git a/src/script/cpp_api/s_client.cpp b/src/script/cpp_api/s_client.cpp index 55d309fda..b2dcc60c4 100644 --- a/src/script/cpp_api/s_client.cpp +++ b/src/script/cpp_api/s_client.cpp @@ -53,7 +53,7 @@ bool ScriptApiClient::on_sending_message(const std::string &message) // Get core.registered_on_chat_messages lua_getglobal(L, "core"); - lua_getfield(L, -1, "registered_on_sending_chat_messages"); + lua_getfield(L, -1, "registered_on_sending_chat_message"); // Call callbacks lua_pushstring(L, message.c_str()); runCallbacks(1, RUN_CALLBACKS_MODE_OR_SC); @@ -67,7 +67,7 @@ bool ScriptApiClient::on_receiving_message(const std::string &message) // Get core.registered_on_chat_messages lua_getglobal(L, "core"); - lua_getfield(L, -1, "registered_on_receiving_chat_messages"); + lua_getfield(L, -1, "registered_on_receiving_chat_message"); // Call callbacks lua_pushstring(L, message.c_str()); runCallbacks(1, RUN_CALLBACKS_MODE_OR_SC);