Mirrorlandia_minetest/minetest
1
0
Fork 1
mirror of https://github.com/minetest/minetest.git synced 2024-11-26 17:43:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document empty string as form name (#14601)

Browse Source
This commit is contained in:
Lars Müller 2024-04-30 13:50:31 +02:00 committed by GitHub
parent ac4f13e78f
commit 2efd0996e6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/lua_api.md
View File

@ -5808,8 +5808,8 @@ Call these functions only at load time!
* Return `true` to mark the command as handled, which means that the default * Return `true` to mark the command as handled, which means that the default
handlers will be prevented. handlers will be prevented.
* `minetest.register_on_player_receive_fields(function(player, formname, fields))` * `minetest.register_on_player_receive_fields(function(player, formname, fields))`
* Called when the server received input from `player` in a formspec with * Called when the server received input from `player`.
the given `formname`. Specifically, this is called on any of the Specifically, this is called on any of the
following events: following events:
* a button was pressed, * a button was pressed,
* Enter was pressed while the focus was on a text field * Enter was pressed while the focus was on a text field
@ -5820,6 +5820,9 @@ Call these functions only at load time!
* an entry was double-clicked in a textlist or table, * an entry was double-clicked in a textlist or table,
* a scrollbar was moved, or * a scrollbar was moved, or
* the form was actively closed by the player. * the form was actively closed by the player.
* `formname` is the name passed to `minetest.show_formspec`.
Special case: The empty string refers to the player inventory
(the formspec set by the `set_inventory_formspec` player method).
* Fields are sent for formspec elements which define a field. `fields` * Fields are sent for formspec elements which define a field. `fields`
is a table containing each formspecs element value (as string), with is a table containing each formspecs element value (as string), with
the `name` parameter as index for each. The value depends on the the `name` parameter as index for each. The value depends on the
@ -6418,7 +6421,8 @@ Formspec
* `minetest.show_formspec(playername, formname, formspec)` * `minetest.show_formspec(playername, formname, formspec)`
* `playername`: name of player to show formspec * `playername`: name of player to show formspec
* `formname`: name passed to `on_player_receive_fields` callbacks. * `formname`: name passed to `on_player_receive_fields` callbacks.
It should follow the `"modname:<whatever>"` naming convention It should follow the `"modname:<whatever>"` naming convention.
`formname` must not be empty.
* `formspec`: formspec to display * `formspec`: formspec to display
* `minetest.close_formspec(playername, formname)` * `minetest.close_formspec(playername, formname)`
* `playername`: name of player to close formspec * `playername`: name of player to close formspec
@ -9667,6 +9671,7 @@ Used by `minetest.register_node`.
on_receive_fields = function(pos, formname, fields, sender), on_receive_fields = function(pos, formname, fields, sender),
-- fields = {name1 = value1, name2 = value2, ...} -- fields = {name1 = value1, name2 = value2, ...}
-- formname should be the empty string; you **must not** use formname.
-- Called when an UI form (e.g. sign text input) returns data. -- Called when an UI form (e.g. sign text input) returns data.
-- See minetest.register_on_player_receive_fields for more info. -- See minetest.register_on_player_receive_fields for more info.
-- default: nil -- default: nil

4
src/script/lua_api/l_server.cpp
View File

@ -426,6 +426,10 @@ int ModApiServer::l_show_formspec(lua_State *L)
NO_MAP_LOCK_REQUIRED; NO_MAP_LOCK_REQUIRED;
const char *playername = luaL_checkstring(L, 1); const char *playername = luaL_checkstring(L, 1);
const char *formname = luaL_checkstring(L, 2); const char *formname = luaL_checkstring(L, 2);
if (*formname == '\0') {
log_deprecated(L, "Deprecated call to `minetest.show_formspec`:"
"`formname` must not be empty");
}
const char *formspec = luaL_checkstring(L, 3); const char *formspec = luaL_checkstring(L, 3);
if(getServer(L)->showFormspec(playername,formspec,formname)) if(getServer(L)->showFormspec(playername,formspec,formname))