BRNSystems/minetest
1
0
Fork 0
forked from Mirrorlandia_minetest/minetest
Code Pull Requests 1 Activity

Warn of biome ID re-allocation when unregistering or clearing biomes (#9359)

Browse Source
This commit is contained in:
Paramat 2020-02-03 00:31:00 +00:00 committed by GitHub
parent 4eb3baa51e
commit b14aa1c847
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/lua_api.txt
View File

@ -4098,6 +4098,9 @@ Call these functions only at load time!
* `minetest.unregister_biome(name)` * `minetest.unregister_biome(name)`
* Unregisters the biome from the engine, and deletes the entry with key * Unregisters the biome from the engine, and deletes the entry with key
`name` from `minetest.registered_biomes`. `name` from `minetest.registered_biomes`.
* Warning: This alters the biome to biome ID correspondences, so any
decorations or ores using the 'biomes' field must afterwards be cleared
and re-registered.
* `minetest.register_decoration(decoration definition)` * `minetest.register_decoration(decoration definition)`
* Returns an integer object handle uniquely identifying the registered * Returns an integer object handle uniquely identifying the registered
decoration on success. To get the decoration ID, use decoration on success. To get the decoration ID, use
@ -4112,12 +4115,15 @@ Call these functions only at load time!
* If the function is called when loading the mod, and `name` is a relative * If the function is called when loading the mod, and `name` is a relative
path, then the current mod path will be prepended to the schematic path, then the current mod path will be prepended to the schematic
filename. filename.
* `minetest.clear_registered_ores()`
* Clears all ores currently registered.
* `minetest.clear_registered_biomes()` * `minetest.clear_registered_biomes()`
* Clears all biomes currently registered. * Clears all biomes currently registered.
* Warning: Clearing and re-registering biomes alters the biome to biome ID
correspondences, so any decorations or ores using the 'biomes' field must
afterwards be cleared and re-registered.
* `minetest.clear_registered_decorations()` * `minetest.clear_registered_decorations()`
* Clears all decorations currently registered. * Clears all decorations currently registered.
* `minetest.clear_registered_ores()`
* Clears all ores currently registered.
* `minetest.clear_registered_schematics()` * `minetest.clear_registered_schematics()`
* Clears all schematics currently registered. * Clears all schematics currently registered.