Browse Source

Lua API: Add register_on_chatcommand to SSM and CSM (#7862)

Allows catching a chatcommand call just after the command and the
parameters are parsed but before its existence is checked and before the
corresponding function is run. Returning `true` from a callback function
will prevent default handling of the command leaving mods to handle the
command manually.
pull/10460/head
Elijah Duffy 5 months ago
committed by GitHub
parent
commit
7d3641021b
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 29 additions and 0 deletions
  1. +5
    -0
      builtin/client/chatcommands.lua
  2. +1
    -0
      builtin/client/register.lua
  3. +5
    -0
      builtin/game/chat.lua
  4. +1
    -0
      builtin/game/register.lua
  5. +4
    -0
      clientmods/preview/init.lua
  6. +5
    -0
      doc/client_lua_api.txt
  7. +5
    -0
      doc/lua_api.txt
  8. +3
    -0
      games/devtest/mods/experimental/commands.lua

+ 5
- 0
builtin/client/chatcommands.lua View File

@@ -23,6 +23,11 @@ core.register_on_sending_chat_message(function(message)
return true
end

-- Run core.registered_on_chatcommand callbacks.
if core.run_callbacks(core.registered_on_chatcommand, 5, cmd, param) then
return true
end

local cmd_def = core.registered_chatcommands[cmd]
if cmd_def then
core.set_last_run_mod(cmd_def.mod_origin)


+ 1
- 0
builtin/client/register.lua View File

@@ -63,6 +63,7 @@ core.registered_on_mods_loaded, core.register_on_mods_loaded = make_registration
core.registered_on_shutdown, core.register_on_shutdown = 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_chatcommand, core.register_on_chatcommand = 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()


+ 5
- 0
builtin/game/chat.lua View File

@@ -58,6 +58,11 @@ core.register_on_chat_message(function(name, message)

param = param or ""

-- Run core.registered_on_chatcommands callbacks.
if core.run_callbacks(core.registered_on_chatcommands, 5, name, cmd, param) then
return true
end

local cmd_def = core.registered_chatcommands[cmd]
if not cmd_def then
core.chat_send_player(name, "-!- Invalid command: " .. cmd)


+ 1
- 0
builtin/game/register.lua View File

@@ -584,6 +584,7 @@ core.unregister_biome = make_wrap_deregistration(core.register_biome,
core.clear_registered_biomes, core.registered_biomes)

core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
core.registered_on_chatcommands, core.register_on_chatcommand = make_registration()
core.registered_globalsteps, core.register_globalstep = make_registration()
core.registered_playerevents, core.register_playerevent = make_registration()
core.registered_on_mods_loaded, core.register_on_mods_loaded = make_registration()


+ 4
- 0
clientmods/preview/init.lua View File

@@ -109,6 +109,10 @@ core.register_on_sending_chat_message(function(message)
return false
end)

core.register_on_chatcommand(function(command, params)
print("[PREVIEW] caught command '"..command.."'. Parameters: '"..params.."'")
end)

-- This is an example function to ensure it's working properly, should be removed before merge
core.register_on_hp_modification(function(hp)
print("[PREVIEW] HP modified " .. hp)


+ 5
- 0
doc/client_lua_api.txt View File

@@ -686,6 +686,11 @@ Call these functions only at load time!
* Adds definition to minetest.registered_chatcommands
* `minetest.unregister_chatcommand(name)`
* Unregisters a chatcommands registered with register_chatcommand.
* `minetest.register_on_chatcommand(function(command, params))`
* Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
is checked to see if that the command exists, but after the input is parsed.
* Return `true` to mark the command as handled, which means that the default
handlers will be prevented.
* `minetest.register_on_death(function())`
* Called when the local player dies
* `minetest.register_on_hp_modification(function(hp))`


+ 5
- 0
doc/lua_api.txt View File

@@ -4606,6 +4606,11 @@ Call these functions only at load time!
* Called always when a player says something
* Return `true` to mark the message as handled, which means that it will
not be sent to other players.
* `minetest.register_on_chatcommand(function(name, command, params))`
* Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
is checked to see if the command exists, but after the input is parsed.
* Return `true` to mark the command as handled, which means that the default
handlers will be prevented.
* `minetest.register_on_player_receive_fields(function(player, formname, fields))`
* Called when the server received input from `player` in a formspec with
the given `formname`. Specifically, this is called on any of the


+ 3
- 0
games/devtest/mods/experimental/commands.lua View File

@@ -214,3 +214,6 @@ minetest.register_chatcommand("test_place_nodes", {
end,
})

core.register_on_chatcommand(function(name, command, params)
minetest.log("caught command '"..command.."', issued by '"..name.."'. Parameters: '"..params.."'")
end)

Loading…
Cancel
Save