6-2024-01-11-2049 error running lua method update (#7)

4c65736975 · web-flow · commit a4126497eeef · 2024-01-25T22:41:58.000+01:00
* cleaned code

* new version update

* fixed a problem with data compatibility with previous settings
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.0.4
+
+Fix:
+
+- fixed a problem with data compatibility with previous settings
+
 ## 1.0.0.3
 
 Features:
@@ -22,4 +28,4 @@ Features:
 
 Features:
 
-- descVersion updated
+- descVersion updated
diff --git a/modDesc.xml b/modDesc.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <modDesc descVersion="79">
   <author>VertexFloat</author>
-  <version>1.0.0.3</version>
+  <version>1.0.0.4</version>
   <title>
     <en>Fov Control</en>
     <de>Fov-Steuerung</de>
@@ -13,40 +13,32 @@
 
 Opening Fov Controller - key combination "left shift + z" (default)
 
-Changelog (1.0.0.3):
-- removed unnecessary code
-- descVersion updated
-- cleaned code
+Changelog (1.0.0.4):
+- fixed a problem with data compatibility with previous settings, from now on old data will be overwritten when saving new ones, unfortunately old data will be ignored when loading
 
 For more information, full changelog, help, and report issues please visit <a href="https://github.com/4c65736975/fovControl">GitHub</a>.]]></en>
     <de><![CDATA[Dank dieser einfachen Modifikation können Sie das Sichtfeld für die aktuell verwendete Fahrzeugkamera einstellen.
 
 Öffnen des Fov-Controllers - Tastenkombination "linke Umschalttaste + z" (Standard)
 
-Änderungsprotokoll (1.0.0.3):
-- Unnötigen Code entfernt
-- descVersion aktualisiert
-- Bereinigter Code
+Änderungsprotokoll (1.0.0.4):
+- Ein Problem mit der Datenkompatibilität mit vorherigen Einstellungen wurde behoben. Von nun an werden alte Daten beim Speichern neuer Daten überschrieben. Leider werden alte Daten beim Laden ignoriert
 
 Weitere Informationen, ein vollständiges Änderungsprotokoll, Hilfe und das Melden von Problemen finden Sie unter <a href="https://github.com/4c65736975/fovControl">GitHub</a>.]]></de>
     <fr><![CDATA[Grâce à cette simple modification, vous pouvez définir le champ de vision de la caméra du véhicule actuellement utilisée.
 
 Ouverture du contrôleur FOV - combinaison de touches "shift gauche + z" (par défaut)
 
-Journal des modifications (1.0.0.3):
-- supprimé le code inutile
-- descVersion mise à jour
-- code nettoyé
+Journal des modifications (1.0.0.4):
+- correction d'un problème de compatibilité des données avec les paramètres précédents, à partir de maintenant les anciennes données seront écrasées lors de l'enregistrement des nouvelles, malheureusement les anciennes données seront ignorées lors du chargement
 
 Pour plus d'informations, le journal des modifications complet, l'aide et signaler des problèmes, veuillez visiter <a href="https://github.com/4c65736975/fovControl">GitHub</a>.]]></fr>
     <pl><![CDATA[Dzięki tej prostej modyfikacji, możesz ustawić pole widzenia dla aktualnie używanej kamery pojazdu.
 
 Otworzenie kontrolera pola widzenia - kombinacja klawiszy "lewy shift + z" (domyślnie)
 
-Dziennik zmian (1.0.0.3):
-- usunięto niepotrzebny kod
-- zaktualizowano descVersion
-- oczyszczono kod
+Dziennik zmian (1.0.0.4):
+- naprawiono problem ze zgodnością danych z poprzednimi ustawieniami, od teraz stare dane będą nadpisywane przy zapisywaniu nowych, niestety stare dane będą ignorowane przy ładowaniu
 
 Po więcej informacji, pełny dziennik zmian, pomoc lub zgłoszenie błędu, odwiedź stronę <a href="https://github.com/4c65736975/fovControl">GitHub</a>.]]></pl>
   </description>
@@ -73,7 +65,7 @@ Po więcej informacji, pełny dziennik zmian, pomoc lub zgłoszenie błędu, odw
       <pl>Usuń tło</pl>
     </text>
     <text name="action_openFovControl">
-      <en>Open fov control</en>
+      <en>Open Fov control</en>
       <de>Öffnen Sie die Fov-Steuerung</de>
       <fr>Ouvrir le contrôle Fov</fr>
       <pl>Otwórz kontroler pola widzenia</pl>
@@ -82,7 +74,7 @@ Po więcej informacji, pełny dziennik zmian, pomoc lub zgłoszenie błędu, odw
       <en>Open Fov control</en>
       <de>Öffnen Sie die Fov-Steuerung</de>
       <fr>Ouvrir le contrôle Fov</fr>
-      <pl>Otwórz kontrolę pola widzenia</pl>
+      <pl>Otwórz kontroler pola widzenia</pl>
     </text>
   </l10n>
 
@@ -93,7 +85,7 @@ Po więcej informacji, pełny dziennik zmian, pomoc lub zgłoszenie błędu, odw
   </inputBinding>
 
   <actions>
-    <action name="TOGGLE_FOV_CONTROL" category="VEHICLE" axisType="HALF"/>
+    <action name="TOGGLE_FOV_CONTROL" category="VEHICLE" axisType="FULL"/>
   </actions>
 
   <extraSourceFiles>
diff --git a/src/FovControl.lua b/src/FovControl.lua
@@ -1,5 +1,5 @@
 -- @author: 4c65736975, All Rights Reserved
--- @version: 1.0.0.2, 20|09|2023
+-- @version: 1.0.0.3, 25|01|2024
 -- @filename: FovControl.lua
 
 -- Changelog (1.0.0.1):
@@ -8,6 +8,9 @@
 -- Changelog (1.0.0.2):
 -- removed unnecessary code
 
+-- Changelog (1.0.0.3):
+-- fixed a problem with data compatibility with previous settings
+
 FovControl = {
   MOD_DIRECTORY = g_currentModDirectory,
   MOD_SETTINGS_DIRECTORY = g_modSettingsDirectory
@@ -17,37 +20,25 @@ source(FovControl.MOD_DIRECTORY .. "src/gui/FovControlGui.lua")
 
 local FovControl_mt = Class(FovControl)
 
----Creating FovControl instance
----@param gui table gui object
----@param l10n table l10n object
----@param settingsModel table settingsModel object
----@return table instance instance of object
 function FovControl.new(customMt, gui, l10n, settingsModel)
   local self = setmetatable({}, customMt or FovControl_mt)
 
-  self.gui = gui
-  self.l10n = l10n
-  self.settingsModel = settingsModel
   self.modifiedVehicles = {}
   self.fovControlGui = FovControlGui.new(nil, gui, l10n, settingsModel)
 
   return self
 end
 
----Initializing FovControl
 function FovControl:initialize()
   self:loadVehicleCameraFovFromXMLFile()
 
   self.fovControlGui:initialize()
 end
 
----Callback on map loading
----@param filename string map file path
 function FovControl:loadMap(filename)
   self.fovControlGui:loadMap()
 end
 
----Loading vehicle camera fov from xml file
 function FovControl:loadVehicleCameraFovFromXMLFile()
   local xmlFile = XMLFile.loadIfExists("FovControlXML", FovControl.MOD_SETTINGS_DIRECTORY .. "fovControl.xml", "vehicles")
 
@@ -61,9 +52,11 @@ function FovControl:loadVehicleCameraFovFromXMLFile()
         xmlFile:iterate(key .. ".cameras.camera", function (_, cameraKey)
           local cameraId = xmlFile:getInt(cameraKey .. "#id")
 
-          self.modifiedVehicles[xmlFilename][cameraId] = {
-            fov = xmlFile:getFloat(cameraKey .. "#fov")
-          }
+          if cameraId then
+            self.modifiedVehicles[xmlFilename][cameraId] = {
+              fov = xmlFile:getFloat(cameraKey .. "#fov")
+            }
+          end
         end)
       end
     end)
@@ -72,7 +65,6 @@ function FovControl:loadVehicleCameraFovFromXMLFile()
   end
 end
 
----Saving vehicle camera fov to xml file
 function FovControl:saveVehicleCameraFovToXMLFile()
   local xmlFile = XMLFile.create("FovControlXML", FovControl.MOD_SETTINGS_DIRECTORY .. "fovControl.xml", "vehicles")
 
@@ -96,7 +88,6 @@ function FovControl:saveVehicleCameraFovToXMLFile()
   end
 end
 
----Save vehicle camera fov
 function FovControl:saveVehicleCameraFov()
   local controlledVehicle = g_currentMission.controlledVehicle
 
@@ -117,17 +108,10 @@ function FovControl:saveVehicleCameraFov()
   self:saveVehicleCameraFovToXMLFile()
 end
 
----ToggleFovControl action event callback
----@param actionName string action name
----@param inputValue integer input value
----@param callbackState any callback state
----@param isAnalog boolean is analog
 function FovControl:actionEventToggleFovControl(actionName, inputValue, callbackState, isAnalog)
   g_gui:showDialog("FovControlDialog")
 end
 
----Gets controlled vehicle active camera fov
----@return float fov vehicle active camera fov
 function FovControl:getVehicleActiveCameraFov()
   local controlledVehicle = g_currentMission.controlledVehicle
 
@@ -142,8 +126,6 @@ function FovControl:getVehicleActiveCameraFov()
   return nil
 end
 
----Gets controlled vehicle active camera default fov
----@return float fov default fov of vehicle active camera or nil when not found
 function FovControl:getVehicleActiveCameraDefaultFov()
   local controlledVehicle = g_currentMission.controlledVehicle
 
@@ -192,8 +174,11 @@ local function onPostLoad(self, savegame)
   if modifiedVehicle ~= nil then
     for i = 1, #spec.cameras do
       local camera = spec.cameras[i]
+      local modifiedCamera = modifiedVehicle[i]
 
-      setFovY(camera.cameraNode, modifiedVehicle[i].fov)
+      if modifiedCamera then
+        setFovY(camera.cameraNode, modifiedCamera.fov)
+      end
     end
   end
 end
diff --git a/src/gui/FovControlGui.lua b/src/gui/FovControlGui.lua
@@ -7,18 +7,14 @@
 
 FovControlGui = {
   MOD_DIRECTORY = g_currentModDirectory,
-  HUD_ATLAS_PATH = g_currentModDirectory .. "data/menu/hud/ui_elements.png"
+  HUD_ATLAS_PATH = g_currentModDirectory .. "data/menu/hud/ui_elements.png",
+  GUI_PROFILES_PATH = g_currentModDirectory .. "data/gui/guiProfiles.xml"
 }
 
 source(FovControlGui.MOD_DIRECTORY .. "src/gui/dialogs/FovControlDialog.lua")
 
 local FovControlGui_mt = Class(FovControlGui)
 
----Creating FovControlGui instance
----@param gui table gui object
----@param l10n table l10n object
----@param settingsModel table settingsModel object
----@return table instance instance of object
 function FovControlGui.new(customMt, gui, l10n, settingsModel)
   local self = setmetatable({}, customMt or FovControlGui_mt)
 
@@ -28,9 +24,8 @@ function FovControlGui.new(customMt, gui, l10n, settingsModel)
   return self
 end
 
----Initializing FovControlGui
 function FovControlGui:initialize()
-  self.gui:loadProfiles(FovControlGui.MOD_DIRECTORY .. "data/gui/guiProfiles.xml")
+  self.gui:loadProfiles(FovControlGui.GUI_PROFILES_PATH)
 
   for _, profile in pairs(self.gui.profiles) do
     for name, value in pairs(profile.values) do
@@ -41,8 +36,6 @@ function FovControlGui:initialize()
   end
 end
 
----Callback on map loading
----@param filename string map file path
 function FovControlGui:loadMap(filename)
   self.gui:loadGui(Utils.getFilename("data/gui/dialogs/FovControlDialog.xml", FovControlGui.MOD_DIRECTORY), "FovControlDialog", self.fovControlDialog)
 end
diff --git a/src/gui/dialogs/FovControlDialog.lua b/src/gui/dialogs/FovControlDialog.lua
@@ -18,10 +18,6 @@ FovControlDialog = {
 
 local FovControlDialog_mt = Class(FovControlDialog, MessageDialog)
 
----Creating FovControlDialog instance
----@param l10n table l10n object
----@param settingsModel table settingsModel object
----@return table instance instance of object
 function FovControlDialog.new(target, customMt, l10n, settingsModel)
   local self = MessageDialog.new(target, customMt or FovControlDialog_mt)
 
@@ -35,14 +31,12 @@ function FovControlDialog.new(target, customMt, l10n, settingsModel)
   return self
 end
 
----Callback on dialog open
 function FovControlDialog:onOpen()
   FovControlDialog:superClass().onOpen(self)
 
   self:updateValues()
 end
 
----Updating dialog values
 function FovControlDialog:updateValues()
   self.fovElement:setTexts(self.settingsModel:getFovYTexts())
 
@@ -52,8 +46,6 @@ function FovControlDialog:updateValues()
   self:setState(self.lastValidFovValue)
 end
 
----Set fov multi text option element state
----@param state float camera fov
 function FovControlDialog:setState(state)
   if state ~= nil then
     if self.settingsModel.fovYToIndexMapping[state] ~= nil then
@@ -64,33 +56,27 @@ function FovControlDialog:setState(state)
   end
 end
 
----Saving current vehicle camera fov
 function FovControlDialog:save()
   g_fovControl:saveVehicleCameraFov()
 end
 
----Callback on click fov value
----@param state integer fov multi text option element state
 function FovControlDialog:onClickFovValue(state)
   self.selectedFovValue = self.settingsModel.indexToFovYMapping[state]
 
   g_currentMission:consoleCommandSetFOV(self.selectedFovValue)
 end
 
----Callback on click apply
 function FovControlDialog:onClickApply()
   self:save()
   self:close()
 end
 
----Callback on click remove background
 function FovControlDialog:onClickRemoveBackground()
   self.bgElement:setVisible(not self.bgElement.visible)
 
   self.btnRemoveBgElement.text = not self.bgElement.visible and self.l10n:getText("button_addBackground"):upper() or self.l10n:getText("button_removeBackground"):upper()
 end
 
----Callback on click reset fov
 function FovControlDialog:onClickResetFov()
   local defaultFovValue = MathUtil.round(math.deg(g_fovControl:getVehicleActiveCameraDefaultFov()))
 
@@ -103,7 +89,6 @@ function FovControlDialog:onClickResetFov()
   g_currentMission:consoleCommandSetFOV(defaultFovValue)
 end
 
----Callback on click back
 function FovControlDialog:onClickBack()
   g_currentMission:consoleCommandSetFOV(self.lastValidFovValue)
 
