Add Spring.SetUnitIconDraw

beyond-all-reason · Dec 16, 2024 · eae2809 · eae2809
1 parent e41b715
commit eae2809
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/rts/Lua/LuaUnsyncedCtrl.cpp b/rts/Lua/LuaUnsyncedCtrl.cpp
@@ -227,7 +227,9 @@ bool LuaUnsyncedCtrl::PushEntries(lua_State* L)
 
 	REGISTER_LUA_CFUNC(AddUnitIcon);
 	REGISTER_LUA_CFUNC(FreeUnitIcon);
-	REGISTER_LUA_CFUNC(UnitIconSetDraw);
+	REGISTER_LUA_CFUNC(UnitIconSetDraw); // deprecated
+	REGISTER_LUA_CFUNC(SetUnitIconDraw);
+
 
 	REGISTER_LUA_CFUNC(ExtractModArchiveFile);
 
@@ -2425,11 +2427,31 @@ int LuaUnsyncedCtrl::FreeUnitIcon(lua_State* L)
 /***
  *
  * @function Spring.UnitIconSetDraw
+ * Deprecated: use Spring.SetUnitIconDraw instead.
+ * @see Spring.SetUnitIconDraw
  * @number unitID
  * @bool drawIcon
  * @treturn nil
  */
 int LuaUnsyncedCtrl::UnitIconSetDraw(lua_State* L)
+{
+	static bool deprecatedMsgDone = false;
+	if (!deprecatedMsgDone) {
+		LOG_L(L_WARNING, "Spring.UnitIconSetDraw is deprecated. Please use Spring.SetUnitIconDraw instead.");
+		deprecatedMsgDone = true;
+	}
+	return LuaUnsyncedCtrl::SetUnitIconDraw(L);
+}
+
+
+/***
+ *
+ * @function Spring.SetUnitIconDraw
+ * @number unitID
+ * @bool drawIcon
+ * @treturn nil
+ */
+int LuaUnsyncedCtrl::SetUnitIconDraw(lua_State* L)
 {
 	CUnit* unit = ParseCtrlUnit(L, __func__, 1);
 

diff --git a/rts/Lua/LuaUnsyncedCtrl.h b/rts/Lua/LuaUnsyncedCtrl.h
@@ -103,6 +103,7 @@ class LuaUnsyncedCtrl {
 
 		static int AddUnitIcon(lua_State* L);
 		static int FreeUnitIcon(lua_State* L);
+		static int SetUnitIconDraw(lua_State* L);
 		static int UnitIconSetDraw(lua_State* L);
 
 		static int ExtractModArchiveFile(lua_State* L);