feat(csm): add register_on_client_ready, register_on_camera_ready and…

… register_on_minimap_ready callback registration functions
snowyu · Jul 4, 2023 · 0dc7a5a · 0dc7a5a
1 parent 1b95998
commit 0dc7a5a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 3 deletions.
diff --git a/builtin/client/register.lua b/builtin/client/register.lua
@@ -81,3 +81,6 @@ core.registered_on_item_use, core.register_on_item_use = make_registration()
 core.registered_on_modchannel_message, core.register_on_modchannel_message = make_registration()
 core.registered_on_modchannel_signal, core.register_on_modchannel_signal = make_registration()
 core.registered_on_inventory_open, core.register_on_inventory_open = make_registration()
+core.registered_on_client_ready, core.register_on_client_ready = make_registration()
+core.registered_on_camera_ready, core.register_on_camera_ready = make_registration()
+core.registered_on_minimap_ready, core.register_on_minimap_ready = make_registration()
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt
@@ -738,6 +738,12 @@ Call these functions only at load time!
     * Called when the local player open inventory
     * Newest functions are called first
     * If any function returns true, inventory doesn't open
+* `minetest.register_on_client_ready(function())`
+    * Called just after localplayer ready.
+* `minetest.register_on_camera_ready(function())`
+    * Called just after camera ready.
+* `minetest.register_on_minimap_ready(function())`
+    * Called just after ui.minimap ready.
 ### Sounds
 * `minetest.sound_play(spec, parameters)`: returns a handle
     * `spec` is a `SimpleSoundSpec`

diff --git a/src/script/scripting_client.cpp b/src/script/scripting_client.cpp
@@ -87,15 +87,48 @@ void ClientScripting::InitializeModApi(lua_State *L, int top)
 
 void ClientScripting::on_client_ready(LocalPlayer *localplayer)
 {
-	LuaLocalPlayer::create(getStack(), localplayer);
+	SCRIPTAPI_PRECHECKHEADER
+
+	LuaLocalPlayer::create(L, localplayer);
+
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "registered_on_client_ready");
+	// Call callbacks
+	try {
+		runCallbacks(0, RUN_CALLBACKS_MODE_FIRST);
+	} catch (LuaError &e) {
+		getClient()->setFatalError(e);
+	}
 }
 
 void ClientScripting::on_camera_ready(Camera *camera)
 {
-	LuaCamera::create(getStack(), camera);
+	SCRIPTAPI_PRECHECKHEADER
+
+	LuaCamera::create(L, camera);
+
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "registered_on_camera_ready");
+	// Call callbacks
+	try {
+		runCallbacks(0, RUN_CALLBACKS_MODE_FIRST);
+	} catch (LuaError &e) {
+		getClient()->setFatalError(e);
+	}
 }
 
 void ClientScripting::on_minimap_ready(Minimap *minimap)
 {
-	LuaMinimap::create(getStack(), minimap);
+	SCRIPTAPI_PRECHECKHEADER
+
+	LuaMinimap::create(L, minimap);
+
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "registered_on_minimap_ready");
+	// Call callbacks
+	try {
+		runCallbacks(0, RUN_CALLBACKS_MODE_FIRST);
+	} catch (LuaError &e) {
+		getClient()->setFatalError(e);
+	}
 }