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

Document minetest.parse_relative_number (#12576)

Browse Source
This commit is contained in:
Wuzzy 2022-09-18 18:38:55 +02:00 committed by GitHub
parent 310b12b5ed
commit 9acf2d3db7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/lua_api.txt
View File

@ -6282,6 +6282,20 @@ Misc.
* Replaces definition of a builtin hud element
* `name`: `"breath"` or `"health"`
* `hud_definition`: definition to replace builtin definition
* `minetest.parse_relative_number(arg, relative_to)`: returns number or nil
* Helper function for chat commands.
* For parsing an optionally relative number of a chat command
parameter, using the chat command tilde notation.
* `arg`: String snippet containing the number; possible values:
* `"<number>"`: return as number
* `"~<number>"`: return `relative_to + <number>`
* `"~"`: return `relative_to`
* Anything else will return `nil`
* `relative_to`: Number to which the `arg` number might be relative to
* Examples:
* `minetest.parse_relative_number("5", 10)` returns 5
* `minetest.parse_relative_number("~5", 10)` returns 15
* `minetest.parse_relative_number("~", 10)` returns 10
* `minetest.send_join_message(player_name)`
* This function can be overridden by mods to change the join message.
* `minetest.send_leave_message(player_name, timed_out)`