diff options
author | paramat <paramat@users.noreply.github.com> | 2018-03-07 03:40:35 +0000 |
---|---|---|
committer | paramat <mat.gregory@virginmedia.com> | 2018-03-10 03:38:27 +0000 |
commit | 644d0ab2bb44df8a3aefb387736930150b7d0aed (patch) | |
tree | 8201d4809b043615c26aaabb91b79d482ee7aac1 /doc/lua_api.txt | |
parent | 473d81f2e2ad4b8077c9cfe241032c67d6a795c3 (diff) | |
download | minetest-644d0ab2bb44df8a3aefb387736930150b7d0aed.tar.gz minetest-644d0ab2bb44df8a3aefb387736930150b7d0aed.tar.bz2 minetest-644d0ab2bb44df8a3aefb387736930150b7d0aed.zip |
Spawn level: Add 'get_spawn_level(x, z)' API
Returns a suitable player spawn y co-ordinate for unmodified terrain.
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r-- | doc/lua_api.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 6fe14472f..0bbf9c79b 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -3035,6 +3035,15 @@ and `minetest.auth_reload` call the authentication handler. unattached `group:attached_node` node to fall. * spread these updates to neighbours and can cause a cascade of nodes to fall. +* `minetest.get_spawn_level(x, z)` + * Returns a player spawn y co-ordinate for the provided (x, z) co-ordinates, + or `nil` for an unsuitable spawn point. + * For most mapgens a 'suitable spawn point' is one with y between + `water_level` and `water_level + 16`, and in mgv7 well away from rivers, + so `nil` will be returned for many (x, z) co-ordinates. + * The spawn level returned is for a player spawn in unmodified terrain. + * The spawn level is intentionally above terrain level to cope with full-node + biome 'dust' nodes. ### Mod channels You can find mod channels communication scheme in `docs/mod_channels.png`. |