summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorShadowNinja <shadowninja@minetest.net>2015-10-29 23:08:32 -0400
committerShadowNinja <shadowninja@minetest.net>2016-03-07 16:33:20 -0500
commit095db16990eea878ce01b29c1eb85a128f98381a (patch)
tree9845f990ebdb7c78c1ecf487cfa91eb29fd2b7db /doc
parent725cb4eb0743a382851e011fb7de1b7d443ce51f (diff)
downloadminetest-095db16990eea878ce01b29c1eb85a128f98381a.tar.gz
minetest-095db16990eea878ce01b29c1eb85a128f98381a.tar.bz2
minetest-095db16990eea878ce01b29c1eb85a128f98381a.zip
Simplify AreaStore ID management
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt3
1 files changed, 1 insertions, 2 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 0520096e7..03b2d5609 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2727,8 +2727,7 @@ If you chose the parameter-less constructor, a fast implementation will be autom
* `get_area(id, include_borders, include_data)`: returns the area with the id `id`. (optional) Boolean values `include_borders` and `include_data` control what's copied.
* `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas that contain the position `pos`. (optional) Boolean values `include_borders` and `include_data` control what's copied.
* `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`: returns all areas that contain all nodes inside the area specified by `edge1` and `edge2` (inclusive). If `accept_overlap` is true, also areas are returned that have nodes in common with the specified area. (optional) Boolean values `include_borders` and `include_data` control what's copied.
-* `insert_area(edge1, edge2, data)`: inserts an area into the store. Returns the id if successful, nil otherwise. The (inclusive) positions `edge1` and `edge2` describe the area, `data`
-is a string stored with the area.
+* `insert_area(edge1, edge2, data)`: inserts an area into the store. Returns the new area's ID, or nil if the insertion failed. The (inclusive) positions `edge1` and `edge2` describe the area, `data` is a string stored with the area.
* `reserve(count)`: reserves resources for at most `count` many contained areas. Only needed for efficiency, and only some implementations profit.
* `remove_area(id)`: removes the area with the given id from the store, returns success.
* `set_cache_params(params)`: sets params for the included prefiltering cache. Calling invalidates the cache, so that its elements have to be newly generated.