1
0
mirror of https://github.com/moparisthebest/minetest synced 2024-11-05 00:45:05 -05:00

Document for api functions that rely on current_modname, that it doesn't work when not loading mods

This commit is contained in:
est31 2015-04-08 22:44:37 +02:00
parent c758fd73ff
commit 0a413265cb
2 changed files with 4 additions and 2 deletions

View File

@ -439,7 +439,8 @@ the global `minetest.registered_*` tables.
* added to `minetest.registered_schematic` with the key of `schematic.name`
* if `schematic.name` is nil, the key is the returned ID
* if the schematic is loaded from a file, schematic.name is set to the filename
* the current mod path will be prepended to the schematic filename if it is a relative path
* if the function is called when loading the mod, and schematic.name is a relative path,
* then the current mod path will be prepended to the schematic filename
* `minetest.clear_registered_biomes()`
* clears all biomes currently registered
@ -1667,7 +1668,7 @@ Helper functions
### Utilities
* `minetest.get_current_modname()`: returns a string
* `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
* `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
* Useful for loading additional `.lua` modules or static data from mod
* `minetest.get_modnames()`: returns a list of installed mods

View File

@ -40,6 +40,7 @@ public:
static Server* getServer(lua_State *L);
static Environment* getEnv(lua_State *L);
static GUIEngine* getGuiEngine(lua_State *L);
// When we are not loading the mod, this function returns "."
static std::string getCurrentModPath(lua_State *L);
// Get an arbitrary subclass of ScriptApiBase