minetest
/
minetest
mirror of https://github.com/minetest/minetest.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Lua_api.txt: Improve bullet point indentation consistency

This commit is contained in:
ezhh 2018-01-13 17:25:01 +00:00 committed by paramat
parent 670f8afd18
commit 5435b07d4e
1 changed files with 133 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/lua_api.txt
View File

@ -2874,17 +2874,20 @@ and `minetest.auth_reload` call the authentication handler.
clear objects in unloaded mapblocks only when the mapblocks are next activated. clear objects in unloaded mapblocks only when the mapblocks are next activated.
* `minetest.emerge_area(pos1, pos2, [callback], [param])` * `minetest.emerge_area(pos1, pos2, [callback], [param])`
* Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
* fetched from memory, loaded from disk, or if inexistent, generates them. fetched from memory, loaded from disk, or if inexistent, generates them.
* If `callback` is a valid Lua function, this will be called for each block emerged. * If `callback` is a valid Lua function, this will be called for each block emerged.
* The function signature of callback is: * The function signature of callback is:
* `function EmergeAreaCallback(blockpos, action, calls_remaining, param)` * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
* - `blockpos` is the *block* coordinates of the block that had been emerged * `blockpos` is the *block* coordinates of the block that had been emerged
* - `action` could be one of the following constant values: * `action` could be one of the following constant values:
* `minetest.EMERGE_CANCELLED`, `minetest.EMERGE_ERRORED`, `minetest.EMERGE_FROM_MEMORY`, * `minetest.EMERGE_CANCELLED`
* `minetest.EMERGE_FROM_DISK`, `minetest.EMERGE_GENERATED` * `minetest.EMERGE_ERRORED`
* - `calls_remaining` is the number of callbacks to be expected after this one * `minetest.EMERGE_FROM_MEMORY`
* - `param` is the user-defined parameter passed to emerge_area (or nil if the * `minetest.EMERGE_FROM_DISK`
* parameter was absent) * `minetest.EMERGE_GENERATED`
* `calls_remaining` is the number of callbacks to be expected after this one
* `param` is the user-defined parameter passed to emerge_area (or nil if the
parameter was absent)
* `minetest.delete_area(pos1, pos2)` * `minetest.delete_area(pos1, pos2)`
* delete all mapblocks in the area from pos1 to pos2, inclusive * delete all mapblocks in the area from pos1 to pos2, inclusive
* `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos` * `minetest.line_of_sight(pos1, pos2)`: returns `boolean, pos`
@ -3153,11 +3156,11 @@ These functions return the leftover itemstack.
* Optional: Variable number of arguments that are passed to `func` * Optional: Variable number of arguments that are passed to `func`
### Server ### Server
* `minetest.request_shutdown([message],[reconnect],[delay])`: request for server shutdown. Will display `message` to clients, * `minetest.request_shutdown([message],[reconnect],[delay])`: request for server shutdown. Will display `message` to clients.
`reconnect` == true displays a reconnect button, * `reconnect` == true displays a reconnect button
`delay` adds an optional delay (in seconds) before shutdown * `delay` adds an optional delay (in seconds) before shutdown.
negative delay cancels the current active shutdown Negative delay cancels the current active shutdown.
zero delay triggers an immediate shutdown. Zero delay triggers an immediate shutdown.
* `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
* `minetest.get_server_status()`: returns server status string * `minetest.get_server_status()`: returns server status string
* `minetest.get_server_uptime()`: returns the server uptime in seconds * `minetest.get_server_uptime()`: returns the server uptime in seconds
@ -3193,8 +3196,7 @@ These functions return the leftover itemstack.
* `minetest.delete_particlespawner(id, player)` * `minetest.delete_particlespawner(id, player)`
* Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`) * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
* If playername is specified, only deletes on the player's client, * If playername is specified, only deletes on the player's client, otherwise on all clients
* otherwise on all clients
### Schematics ### Schematics
* `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)` * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
@ -4193,10 +4195,10 @@ the object.
It can be created via `Raycast(pos1, pos2, objects, liquids)` or It can be created via `Raycast(pos1, pos2, objects, liquids)` or
`minetest.raycast(pos1, pos2, objects, liquids)` where: `minetest.raycast(pos1, pos2, objects, liquids)` where:
* `pos1`: start of the ray * `pos1`: start of the ray
* `pos2`: end of the ray * `pos2`: end of the ray
* `objects` : if false, only nodes will be returned. Default is true. * `objects` : if false, only nodes will be returned. Default is true.
* `liquids' : if false, liquid nodes won't be returned. Default is false. * `liquids' : if false, liquid nodes won't be returned. Default is false.
#### Methods #### Methods
* `next()`: returns a `pointed_thing` * `next()`: returns a `pointed_thing`