diff options
| author | Beha <shacknetisp@mail.com> | 2019-07-29 08:09:29 -0400 |
|---|---|---|
| committer | sfan5 <sfan5@live.de> | 2019-07-29 14:09:29 +0200 |
| commit | 50052fced51c6a97414472a84aac8ec9bb57d3ee (patch) | |
| tree | 3f904efea1439464b803006be8aeddc6477ea638 | |
| parent | 705630e7d09a2c6b80631186f597671a8db5e34b (diff) | |
| download | minetest-50052fced51c6a97414472a84aac8ec9bb57d3ee.tar.gz minetest-50052fced51c6a97414472a84aac8ec9bb57d3ee.tar.bz2 minetest-50052fced51c6a97414472a84aac8ec9bb57d3ee.zip | |
lua_api.txt clarifications regarding mapgen object index IDs and handles. (#8713)
| -rw-r--r-- | doc/lua_api.txt | 27 |
1 files changed, 16 insertions, 11 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index be5eddd8a..22bd6f548 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -3481,7 +3481,7 @@ Possible fields of the table returned are: * `decoration` 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. * `minetest.register_alias_force(alias, original_name)` * `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. * `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)` * Unregisters the biome from the engine, and deletes the entry with key `name` from `minetest.registered_biomes`. * `minetest.register_decoration(decoration definition)` - * Returns an integer uniquely identifying the registered decoration on - success. + * Returns an integer object handle uniquely identifying the registered + decoration on success. To get the decoration ID, use + `minetest.get_decoration_id`. * The order of decoration registrations determines the order of decoration generation. * `minetest.register_schematic(schematic definition)` - * Returns an integer uniquely identifying the registered schematic on - success. + * Returns an integer object handle uniquely identifying the registered + schematic on success. * If the schematic is loaded from a file, the `name` field is set to the filename. * 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 * `minetest.registered_ores` * 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` * 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` * 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.registered_schematics` * 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.registered_chatcommands` * Map of registered chat command definitions, indexed by name |