Merge pull request #13 from VertexDezign/fix-issue-with-add-spec

Fix issue with add spec

Author: Grisu118

ParkVehicle.lua

@@ -6,18 +6,25 @@
 --              v2.0.0.0 - 2018-12-03 - FS19
 --              v2.1.0.0 - 2019-04-01 - Support all enterable vehicles, create modSettings folder
 --              v3.0.0.0 - 2021-11-19 - FS22
+--              v3.1.0.0 - 2022-04-23 - Add possibiltiy to unpark all, fix issue with registration in loader
 -- @Descripion: Allows temporary disabling of the tab function
 -- @web: https://grisu118.ch or https://vertexdezign.net
 -- Copyright (C) Grisu118, All Rights Reserved.
 
+---@class ParkVehicle
 ParkVehicle = {}
 ParkVehicle.inputName = "parkVehicle"
-ParkVehicle.modDir = g_currentModDirectory
+ParkVehicle.modDir = g_parkVehicleSystem.modDir
 
 function ParkVehicle.prerequisitesPresent(specializations)
   return SpecializationUtil.hasSpecialization(Enterable, specializations)
 end
 
+function ParkVehicle.registerFunctions(vehicleType)
+  SpecializationUtil.registerFunction(vehicleType, "getParkVehicleState", ParkVehicle.getParkVehicleState)
+  SpecializationUtil.registerFunction(vehicleType, "setParkVehicleState", ParkVehicle.setParkVehicleState)
+end
+
 function ParkVehicle.registerEventListeners(vehicleType)
   SpecializationUtil.registerEventListener(vehicleType, "onLoad", ParkVehicle)
   SpecializationUtil.registerEventListener(vehicleType, "onUpdate", ParkVehicle)
@@ -27,6 +34,7 @@ function ParkVehicle.registerEventListeners(vehicleType)
   SpecializationUtil.registerEventListener(vehicleType, "onWriteUpdateStream", ParkVehicle)
   SpecializationUtil.registerEventListener(vehicleType, "onReadUpdateStream", ParkVehicle)
   SpecializationUtil.registerEventListener(vehicleType, "onRegisterActionEvents", ParkVehicle)
+  SpecializationUtil.registerEventListener(vehicleType, "onDelete", ParkVehicle)
 end
 
 function ParkVehicle:onLoad(savegame)
@@ -55,6 +63,7 @@ function ParkVehicle:onLoad(savegame)
   end
 
   spec.inputPressed = false
+  spec.registrationKey = nil
   spec.actionEvents = {}
   spec.icon = createImageOverlay(ParkVehicle.modDir .. "icon.png")
   spec.overlay = createImageOverlay(ParkVehicle.modDir .. "overlay.png")
@@ -66,7 +75,12 @@ function ParkVehicle:onLoad(savegame)
   if savegame ~= nil then
     local i = 0
     while true do
-      local key = string.format("%s.ParkVehicle.player(%d)", savegame.key, i)
+
+      local legacykey = string.format("%s.ParkVehicle.player(%d)", savegame.key, i) -- TODO Remove with next release
+      local key = string.format("%s.%s.ParkVehicle.player(%d)", savegame.key, g_parkVehicleSystem.modName, i)
+      if not hasXMLProperty(savegame.xmlFile.handle, key) then
+        key = legacykey
+      end
       if not hasXMLProperty(savegame.xmlFile.handle, key) then
         break
       end
@@ -85,21 +99,34 @@ function ParkVehicle:onLoad(savegame)
   end
 
   self.spec_enterable:setIsTabbable(not spec.state[spec.uniqueUserId])
+  spec.registrationKey = g_parkVehicleSystem:registerInstance(self)
 end
 
 function ParkVehicle:onUpdate(dt, isActiveForInput, isSelected)
   if self.isClient then
     local spec = self.spec_parkvehicle
     if spec.inputPressed then
-      local newValue = not spec.state[spec.uniqueUserId]
-      self.spec_enterable:setIsTabbable(not newValue)
-      spec.state[spec.uniqueUserId] = newValue
-      self:raiseDirtyFlags(spec.dirtyFlag)
+      local newValue = not self:getParkVehicleState()
+      self:setParkVehicleState(newValue)
       spec.inputPressed = false
     end
   end
 end
 
+---@param newValue boolean
+function ParkVehicle:setParkVehicleState(newValue)
+  local spec = self.spec_parkvehicle
+  self.spec_enterable:setIsTabbable(not newValue)
+  spec.state[spec.uniqueUserId] = newValue
+  self:raiseDirtyFlags(spec.dirtyFlag)
+end
+
+---@return boolean
+function ParkVehicle:getParkVehicleState()
+  local spec = self.spec_parkvehicle
+  return spec.state[spec.uniqueUserId]
+end
+
 function ParkVehicle:onDraw()
   if self.isClient and self:getIsActive() then
     local spec = self.spec_parkvehicle
@@ -116,6 +143,12 @@ function ParkVehicle:onDraw()
   end
 end
 
+function ParkVehicle:onDelete()
+  local spec = self.spec_parkvehicle
+  print("onDelete")
+  g_parkVehicleSystem:unregisterInstance(spec.registrationKey)
+end
+
 --Called on server side on join
 -- @param integer streamId streamId
 -- @param integer connection connection
@@ -234,5 +267,6 @@ function ParkVehicle.randomString(length)
     math.randomseed(getDate("%d%m%y%H%M%S"))
     return randomString(length - 1) .. charset[math.random(1, #charset)]
   end
+
   return randomString(length)
 end

ParkVehicleSystem.lua

@@ -0,0 +1,95 @@
+--- Global instance of park vehicle.
+---@class ParkVehicleSystem
+---@field modName string
+---@field modDir string
+---@field inputManager InputBinding
+---@field debug boolean
+---@field instances table<integer, ParkVehicle>
+---@field counter integer Increased if an instance is registered, used as key within the table
+ParkVehicleSystem = {}
+
+local ParkVehicleSystem_mt = Class(ParkVehicleSystem)
+
+---
+---@param modName string
+---@param modDir string
+---@param inputManager InputBinding
+---@param debug boolean
+---@return ParkVehicleSystem
+function ParkVehicleSystem:new(modName, modDir, inputManager, debug)
+    local self = {}
+
+    setmetatable(self, ParkVehicleSystem_mt)
+
+    self.modName = modName
+    self.modDir = modDir
+    self.debug = debug
+    self.inputManager = inputManager
+
+    self.instances = {}
+    self.counter = 0
+
+    return self
+end
+
+---@param typeManager TypeManager
+---@param specManager SpecializationManager
+function ParkVehicleSystem:installSpecialization(typeManager, specManager)
+    -- register spec
+    specManager:addSpecialization("parkVehicle", "ParkVehicle", Utils.getFilename("ParkVehicle.lua", self.modDir), nil)
+
+    -- add spec to vehicle types
+    local totalCount = 0
+    local modified = 0
+    for typeName, typeEntry in pairs(typeManager:getTypes()) do
+        totalCount = totalCount + 1
+        if SpecializationUtil.hasSpecialization(Enterable, typeEntry.specializations) and
+            not SpecializationUtil.hasSpecialization(Rideable, typeEntry.specializations) and
+            not SpecializationUtil.hasSpecialization(ParkVehicle, typeEntry.specializations) then
+            typeManager:addSpecialization(typeName, self.modName .. ".parkVehicle")
+            modified = modified + 1
+            if (self.debug) then
+                print("Adding park vehicle to " .. typeName)
+            end
+        else
+            if (self.debug) then
+                print("Not adding park vehicle to " .. typeName)
+            end
+        end
+    end
+
+    print(string.format("Inserted Park Vehicle into %i of %i vehicle types", modified, totalCount))
+end
+
+function ParkVehicleSystem:registerActionEvents()
+    local _, eventId = self.inputManager:registerActionEvent(InputAction.PARKVEHICLE_UNPARK_ALL, self, self.unparkAll, false, true, false, true)
+    self.inputManager:setActionEventTextPriority(eventId, GS_PRIO_VERY_LOW)
+  
+  end
+  
+  function ParkVehicleSystem:unregisterActionEvents()
+    self.inputManager:removeActionEventsByTarget(self)
+  end
+
+---@param instance ParkVehicle
+---@return integer the key to unregister this instance
+function ParkVehicleSystem:registerInstance(instance)
+    local key = self.counter
+    self.instances[key] = instance
+
+    
+    self.counter = self.counter + 1
+
+    return key
+end
+
+---@param key integer
+function ParkVehicleSystem:unregisterInstance(key)
+    self.instances[key] = nil
+end
+
+function ParkVehicleSystem:unparkAll()
+    for _, value in pairs(self.instances) do
+        value:setParkVehicleState(false)
+    end
+end

Readme.md

@@ -2,7 +2,7 @@
 
 [![ModHub Download](https://img.shields.io/badge/%5BFS17%5D%20ModHub-1.0.1.0-green.svg?style=flat-square)](https://farming-simulator.com/mod.php?lang=de&country=ch&mod_id=91210&title=fs2017)
 [![ModHub Download](https://img.shields.io/badge/%5BFS19%5D%20ModHub-1.1.0.0-green.svg?style=flat-square)](https://farming-simulator.com/mod.php?mod_id=125747&title=fs2019)
-[![ModHub Download](https://img.shields.io/badge/%5BFS22%5D%20ModHub-1.0.0.0-blue.svg?style=flat-square)](https://farming-simulator.com/mod.php?mod_id=224816)
+[![ModHub Download](https://img.shields.io/badge/%5BFS22%5D%20ModHub-1.1.0.0-blue.svg?style=flat-square)](https://farming-simulator.com/mod.php?mod_id=224816)
 
 A small script, which allows temporary disabling of tabbing function for a vehicle