Mirrorlandia_minetest/minetest
1
0
Fork 1
mirror of https://github.com/minetest/minetest.git synced 2024-12-23 22:52:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

lua_api.txt clarifications regarding mapgen object index IDs and handles. (#8713)

Browse Source
This commit is contained in:
Beha 2019-07-29 08:09:29 -04:00 committed by sfan5
parent 705630e7d0
commit 50052fced5
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/lua_api.txt
View File

@ -3481,7 +3481,7 @@ Possible fields of the table returned are:
* `decoration` * `decoration`
Decorations have a key in the format of `"decoration#id"`, where `id` is the Decorations have a key in the format of `"decoration#id"`, where `id` is the
numeric unique decoration ID. numeric unique decoration ID as returned by `minetest.get_decoration_id`.
@ -3750,21 +3750,24 @@ Call these functions only at load time!
mapgens. See [Mapgen aliases] section above. mapgens. See [Mapgen aliases] section above.
* `minetest.register_alias_force(alias, original_name)` * `minetest.register_alias_force(alias, original_name)`
* `minetest.register_ore(ore definition)` * `minetest.register_ore(ore definition)`
* Returns an integer uniquely identifying the registered ore on success. * Returns an integer object handle uniquely identifying the registered
ore on success.
* The order of ore registrations determines the order of ore generation. * The order of ore registrations determines the order of ore generation.
* `minetest.register_biome(biome definition)` * `minetest.register_biome(biome definition)`
* Returns an integer uniquely identifying the registered biome on success. * Returns an integer object handle uniquely identifying the registered
biome on success. To get the biome ID, use `minetest.get_biome_id`.
* `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`.
* `minetest.register_decoration(decoration definition)` * `minetest.register_decoration(decoration definition)`
* Returns an integer uniquely identifying the registered decoration on * Returns an integer object handle uniquely identifying the registered
success. decoration on success. To get the decoration ID, use
`minetest.get_decoration_id`.
* The order of decoration registrations determines the order of decoration * The order of decoration registrations determines the order of decoration
generation. generation.
* `minetest.register_schematic(schematic definition)` * `minetest.register_schematic(schematic definition)`
* Returns an integer uniquely identifying the registered schematic on * Returns an integer object handle uniquely identifying the registered
success. schematic on success.
* If the schematic is loaded from a file, the `name` field is set to the * If the schematic is loaded from a file, the `name` field is set to the
filename. filename.
* 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
@ -4978,17 +4981,19 @@ Global tables
* Map of registered aliases, indexed by name * Map of registered aliases, indexed by name
* `minetest.registered_ores` * `minetest.registered_ores`
* Map of registered ore definitions, indexed by the `name` field. * Map of registered ore definitions, indexed by the `name` field.
* If `name` is nil, the key is the ID returned by `minetest.register_ore`. * If `name` is nil, the key is the object handle returned by
`minetest.register_ore`.
* `minetest.registered_biomes` * `minetest.registered_biomes`
* Map of registered biome definitions, indexed by the `name` field. * Map of registered biome definitions, indexed by the `name` field.
* If `name` is nil, the key is the ID returned by `minetest.register_biome`. * If `name` is nil, the key is the object handle returned by
`minetest.register_biome`.
* `minetest.registered_decorations` * `minetest.registered_decorations`
* Map of registered decoration definitions, indexed by the `name` field. * Map of registered decoration definitions, indexed by the `name` field.
* If `name` is nil, the key is the ID returned by * If `name` is nil, the key is the object handle returned by
`minetest.register_decoration`. `minetest.register_decoration`.
* `minetest.registered_schematics` * `minetest.registered_schematics`
* Map of registered schematic definitions, indexed by the `name` field. * Map of registered schematic definitions, indexed by the `name` field.
* If `name` is nil, the key is the ID returned by * If `name` is nil, the key is the object handle returned by
`minetest.register_schematic`. `minetest.register_schematic`.
* `minetest.registered_chatcommands` * `minetest.registered_chatcommands`
* Map of registered chat command definitions, indexed by name * Map of registered chat command definitions, indexed by name