From: est31 <MTest31@outlook.com>
Date: Wed, 8 Apr 2015 20:44:37 +0000 (+0200)
Subject: Document for api functions that rely on current_modname, that it doesn't work when... 
X-Git-Tag: 0.4.13~378
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=0a413265cb7057b5303733dd32cf802a9ecf6105;p=oweals%2Fminetest.git

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

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index eae7e537b..0aa3691d8 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -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
diff --git a/src/script/lua_api/l_base.h b/src/script/lua_api/l_base.h
index c580e9597..641013dfd 100644
--- a/src/script/lua_api/l_base.h
+++ b/src/script/lua_api/l_base.h
@@ -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