Add new behaviour for loadAndRemove

enginmanap · Sep 1, 2018 · b5446b2 · b5446b2
1 parent 4c51c07
commit b5446b2
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/APIUsage.rst b/docs/APIUsage.rst
@@ -280,7 +280,7 @@ Parameters:
 bool LoadAndRemove(const std::string& worldFileName)
 ====================================================
 
-Loads the world requested, and removes the current world. Returns true.
+Loads the world requested, and removes the current world. Returns true if load successful, false if not. If not successful, world doesn't change.
 
 It is used to switch between big worlds, like game maps. It is not necessary to clear menu worlds since they use very little memory.