From 687aba591eb9b1f8a7d6ea9095d9b76facaad47b Mon Sep 17 00:00:00 2001
From: Eduardo Dantas <eduardo.dantas@hotmail.com.br>
Date: Thu, 12 Sep 2024 23:40:07 -0300
Subject: [PATCH] fix: float precision in config retrieval (#2889)

Description:
This addresses the issue where floating point values
retrieved from the configuration were not being rounded properly,
leading to slight inaccuracies. This fix ensures that all float values
are correctly rounded to two decimal places before being passed to Lua,
thereby ensuring consistent behavior and data accuracy.

Expected behavior:
With the implemented changes, when floating point values are retrieved,
they will now be rounded to two decimal places. For example, a
configured value of `1.15` will correctly be returned as `1.15` in Lua
scripts.
---
 .../functions/core/game/config_functions.cpp  | 13 +++++++--
 .../functions/core/game/config_functions.hpp  | 27 +++++++++++++++++++
 2 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/src/lua/functions/core/game/config_functions.cpp b/src/lua/functions/core/game/config_functions.cpp
index d0e77a69352..b839f720057 100644
--- a/src/lua/functions/core/game/config_functions.cpp
+++ b/src/lua/functions/core/game/config_functions.cpp
@@ -70,12 +70,21 @@ int ConfigFunctions::luaConfigManagerGetBoolean(lua_State* L) {
 }
 
 int ConfigFunctions::luaConfigManagerGetFloat(lua_State* L) {
-	auto key = getNumber<ConfigKey_t>(L, -1);
+	// configManager.getFloat(key, shouldRound = true)
+
+	// Ensure the first argument (key) is provided and is a valid enum
+	auto key = getNumber<ConfigKey_t>(L, 1);
 	if (!key) {
 		reportErrorFunc("Wrong enum");
 		return 1;
 	}
 
-	lua_pushnumber(L, g_configManager().getFloat(key, __FUNCTION__));
+	// Check if the second argument (shouldRound) is provided and is a boolean; default to true if not provided
+	bool shouldRound = getBoolean(L, 2, true);
+	float value = g_configManager().getFloat(key, __FUNCTION__);
+	double finalValue = shouldRound ? static_cast<double>(std::round(value * 100.0) / 100.0) : value;
+
+	g_logger().debug("[{}] key: {}, finalValue: {}, shouldRound: {}", __METHOD_NAME__, magic_enum::enum_name(key), finalValue, shouldRound);
+	lua_pushnumber(L, finalValue);
 	return 1;
 }
diff --git a/src/lua/functions/core/game/config_functions.hpp b/src/lua/functions/core/game/config_functions.hpp
index ae4952e9643..9806a35f426 100644
--- a/src/lua/functions/core/game/config_functions.hpp
+++ b/src/lua/functions/core/game/config_functions.hpp
@@ -17,6 +17,33 @@ class ConfigFunctions final : LuaScriptInterface {
 	static void init(lua_State* L);
 
 private:
+	/**
+	 * @brief Retrieves a float configuration value from the configuration manager, with an optional rounding.
+	 *
+	 * This function is a Lua binding used to get a float value from the configuration manager. It requires
+	 * a key as the first argument, which should be a valid enumeration. An optional second boolean argument
+	 * specifies whether the retrieved float should be rounded to two decimal places.
+	 *
+	 * @param L Pointer to the Lua state. The first argument must be a valid enum key, and the second argument (optional)
+	 * can be a boolean indicating whether to round the result.
+	 *
+	 * @return Returns 1 after pushing the result onto the Lua stack, indicating the number of return values.
+	 *
+	 * @exception reportErrorFunc Throws an error if the first argument is not a valid enum.
+	 *
+	 * Usage:
+	 *  local result = ConfigManager.getFloat(ConfigKey.SomeKey)
+	 *  local result_rounded = ConfigManager.getFloat(ConfigKey.SomeKey, false)
+	 *
+	 * Detailed behavior:
+	 * 1. Extracts the key from the first Lua stack argument as an enumeration of type `ConfigKey_t`.
+	 * 2. Checks if the second argument is provided; if not, defaults to true for rounding.
+	 * 3. Retrieves the float value associated with the key from the configuration manager.
+	 * 4. If rounding is requested, rounds the value to two decimal places.
+	 * 5. Logs the method call and the obtained value using the debug logger.
+	 * 6. Pushes the final value (rounded or original) back onto the Lua stack.
+	 * 7. Returns 1 to indicate a single return value.
+	 */
 	static int luaConfigManagerGetFloat(lua_State* L);
 	static int luaConfigManagerGetBoolean(lua_State* L);
 	static int luaConfigManagerGetNumber(lua_State* L);