Merge branch 'dev'

Author: aoqia194

CHANGELOG.md

@@ -5,7 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] -- 2024-10-28
+## [0.2.0] - 2024-11-16
+
+### Fixed
+
+- Vehicle mod data not syncing properly when claiming.
+
+### Added
+
+- Sandbox option to discard previous vehicle interior when converting to pinkslip.
+- A warning when discarding vehicle interior.
+
+## [0.1.0] - 2024-10-28
 
 ### Added
 

src/media/lua/client/AoqiaCarwannaExtendedClient/actions/create_pinkslip.lua

@@ -43,9 +43,9 @@ end
 
 function create_pinkslip:update()
     self.character:faceThisObject(self.vehicle)
-    self.character:setMetabolicTarget(Metabolics.LightDomestic)
+    self.character:setMetabolicTarget(Metabolics.LightDomestic --[[@as float]])
 
-    if self.character:getEmitter():isPlaying(self.sound) == false then
+    if self.character:getEmitter():isPlaying(self.sound --[[@as string]]) == false then
         self.sound = self.character:playSound("CreatePinkslip")
     end
 end
@@ -121,7 +121,7 @@ function create_pinkslip:perform()
     local key = player_inventory:haveThisKeyId(self.vehicle:getKeyId())
     if key and mdata.HasKey == false then
         mdata.MakeKey = true
-        player_inventory:Remove(key)
+        player_inventory:Remove(key --[[@as string]])
     end
 
     local parts = mdata.Parts
@@ -248,10 +248,11 @@ function create_pinkslip:perform()
     mdata.PartsMissing = missing_parts
 
     -- Remove form item if required.
-    if sbvars.DoRequiresAutoForm and sbvars.DoKeepAutoForm == false then
+    if sbvars.DoRequiresAutoForm then
         logger:debug("Removing form from inventory...")
 
         local form = player_inventory:getFirstTypeRecurse(mod_constants.MOD_ID .. ".AutoForm")
+        --- @diagnostic disable-next-line: param-type-mismatch
         form:getContainer():Remove(form)
     end
 

src/media/lua/client/AoqiaCarwannaExtendedClient/ui/pinkslip.lua

@@ -64,11 +64,23 @@ end
 --- @param player IsoPlayer
 --- @param vehicle BaseVehicle
 function pinkslip.confirm_dialog(player, vehicle)
+    local sbvars = SandboxVars[mod_constants.MOD_ID] --[[@as SandboxVarsDummy]]
+
     local player_num = player:getPlayerNum()
 
-    local confirm_text = getText(
-        ("IGUI_%s_ConfirmText"):format(mod_constants.MOD_ID),
-        getText("IGUI_VehicleName" .. vehicle:getScript():getName()))
+    local interior_warning = nil
+    if sbvars.DoCompatRvInteriors and sbvars.DoUnassignInterior and RVInterior.vehicleHasInteriorParameters(vehicle) then
+        interior_warning = getText(("IGUI_%s_ConfirmInteriorWarning"):format(mod_constants.MOD_ID))
+    end
+
+    local confirm_text = getText(("IGUI_%s_ConfirmText"):format(mod_constants.MOD_ID),
+            getText("IGUI_VehicleName" .. vehicle:getScript():getName()))
+        .. " <LINE> <RGB:1,0,0> "
+
+    if interior_warning then
+        confirm_text = confirm_text .. interior_warning
+    end
+
     local modal = ISModalRichText:new(
         0,
         0,
@@ -400,14 +412,34 @@ function pinkslip.add_option_to_menu(player, context, vehicle)
         if sq_dist == nil
         or (sbvars.SafehouseDistance == 0 and in_safehouse_area == false)
         or (sbvars.SafehouseDistance > 0 and sq_dist > sbvars.SafehouseDistance) then
-            text = text ..
-                " <LINE> <LINE> <RGB:1,0,0> " ..
-                getText(("Tooltip_%s_DoSafehouseOnly"):format(mod_constants
-                    .MOD_ID))
+            text = text
+                .. " <LINE> <LINE> <RGB:1,0,0> "
+                .. getText(("Tooltip_%s_DoSafehouseOnly"):format(mod_constants.MOD_ID))
             not_available = true
         end
     end
 
+    -- Shouldn't be able to claim if your friends are in the interior LOL.
+    if sbvars.DoCompatRvInteriors and RVInterior.vehicleHasInteriorParameters(vehicle) then
+        local interior_vehicle_name = RVInterior.getVehicleName(vehicle_name)
+        local interior_vehicle_moddata = RVInterior.getVehicleModData(vehicle,
+            RVInterior.getInteriorParameters(interior_vehicle_name))
+
+        if interior_vehicle_moddata then
+            local online_players = getOnlinePlayers()
+            for i = 1, online_players:size() do
+                local target = online_players:get(i - 1) --[[@as IsoPlayer]]
+
+                if RVInterior.playerInsideInterior(target) == interior_vehicle_name then
+                    text = text
+                        .. " <LINE> <LINE> <RGB:1,0,0> "
+                        .. getText(("Tooltip_%s_PlayersInInterior"):format(mod_constants.MOD_ID))
+                    not_available = true
+                end
+            end
+        end
+    end
+
     -- Do admin override if enabled.
     if  not_available
     and player:getAccessLevel() == "Admin"

src/media/lua/server/AoqiaCarwannaExtendedServer/commands.lua

@@ -36,13 +36,22 @@ function commands.spawn_vehicle(player, args)
     logger:info_server("Spawning vehicle (%s) at (%f, %f, %f).",
         tostring(args.FullType), x, y, z)
 
-    -- Check if vehicle exists
+    -- Check if player is on Z level 0.
+    -- The engine is limited to only spawning vehicles on Z-level 0.
+    if z > 0 then
+        logger:info_server("Failed to spawn vehicle as the player is not on Z-level 0.")
+        player.setHaloNote(getText(("IGUI_%s_HaloNote_NotOnGround"):format(mod_constants.MOD_ID)),
+            1, 0, 0, (128.0 * 4))
+
+        return
+    end
+
+    -- Check if vehicle exists.
     if ScriptManager:getVehicle(args.FullType) == nil then
         logger:warn_server(
             "Failed to spawn vehicle as the vehicle does not exist.")
-        player:setHaloNote(getText(
-            ("IGUI_%s_HaloNote_NilVehicle"):format(mod_constants.MOD_ID)
-        ))
+        player.setHaloNote(getText(("IGUI_%s_HaloNote_NilVehicle"):format(mod_constants.MOD_ID)),
+            1, 0, 0, (128.0 * 4))
 
         return
     end
@@ -52,9 +61,8 @@ function commands.spawn_vehicle(player, args)
     and player:getInventory():containsTypeRecurse("AutoForm") == false then
         logger:info_server(
             "Failed to spawn vehicle as the player does not have an AutoForm.")
-        player:setHaloNote(getText(
-            ("IGUI_%s_HaloNote_NoAutoForm"):format(mod_constants.MOD_ID)
-        ))
+        player.setHaloNote(getText(("IGUI_%s_HaloNote_NoAutoForm"):format(mod_constants.MOD_ID)),
+            1, 0, 0, (128.0 * 4))
 
         return
     end
@@ -63,9 +71,9 @@ function commands.spawn_vehicle(player, args)
     if square:isVehicleIntersecting() then
         logger:info_server(
             "Failed to spawn vehicle, there is already a vehicle spawned there.")
-        player:setHaloNote(getText(
-            ("IGUI_%s_HaloNote_VehicleIntersecting"):format(mod_constants.MOD_ID)
-        ))
+        player.setHaloNote(
+            getText(("IGUI_%s_HaloNote_VehicleIntersecting"):format(mod_constants.MOD_ID)),
+            1, 0, 0, (128.0 * 4))
 
         return
     end
@@ -166,6 +174,21 @@ function commands.spawn_vehicle(player, args)
         end
     end
 
+    -- Sync mod data to vehicle.
+    if args.ModData then
+        logger:debug_server("Syncing mod data.")
+
+        for k, v in pairs(args.ModData) do
+            vehicle:getModData()[k] = v
+        end
+    end
+
+    -- Give the player the autoform back if sandbox option is on
+    if sbvars.DoKeepAutoForm then
+        --- @diagnostic disable-next-line: redundant-parameter
+        player:sendObjectChange("addItem", { item = InventoryItemFactory.CreateItem("AutoForm") })
+    end
+
     local parts = args.Parts
     if parts == nil
     or parts.index == nil

src/media/lua/server/AoqiaCarwannaExtendedServer/events.lua

@@ -27,7 +27,7 @@ function events.on_client_command(module, command, player, args)
     end
 
     logger:info_server("Received client command (%s) from player (%s) <%s>.", command,
-        player:getUsername(), tostring(player:getSteamID()))
+        player:getUsername(), tostring(getSteamIDFromUsername(player:getUsername())))
     commands[command](player, args)
 end
 

src/media/lua/server/AoqiaCarwannaExtendedServer/recipes.lua

@@ -39,21 +39,29 @@ end
 Recipe.OnCanPerform[mod_constants.MOD_ID].ClaimVehicle = function (recipe, player, item)
     --- @cast player IsoPlayer
 
-    local perform = true
-
     local sbvars = SandboxVars[mod_constants.MOD_ID] --[[@as SandboxVarsDummy]]
 
+    local player_username = player:getUsername()
+    logger:info_server("Player (%s) <%s> is trying to claim a vehicle using pinkslip!",
+        tostring(player_username), tostring(getSteamIDFromUsername(player_username)))
+
+    local perform = true
+
     -- If the player is not outside, don't claim it.
     local player_sq = player:getSquare()
     if player:isOutside() == false then
-        player:setHaloNote(getText(("IGUI_%s_HaloNote_NotOutside")
-            :format(mod_constants.MOD_ID)))
+        player.setHaloNote(getText(("IGUI_%s_HaloNote_NotOutside"):format(mod_constants.MOD_ID)),
+            1, 0, 0, (128.0 * 4))
+        logger:debug_server("Failed to spawn vehicle as the player is not outside.")
         perform = false
     end
 
     if player_sq:isVehicleIntersecting() then
-        player:setHaloNote(getText(("IGUI_%s_HaloNote_VehicleIntersecting")
-            :format(mod_constants.MOD_ID)))
+        player.setHaloNote(
+            getText(("IGUI_%s_HaloNote_VehicleIntersecting"):format(mod_constants.MOD_ID)),
+            1, 0, 0, (128.0 * 4))
+        logger:debug_server(
+            "Failed to spawn vehicle as the player is intersecting with another vehicle.")
         perform = false
     end
 
@@ -77,7 +85,7 @@ Recipe.OnCanPerform[mod_constants.MOD_ID].ClaimVehicle = function (recipe, playe
         for i = 1, safehouses:size() do
             local temp = safehouses:get(i - 1) --[[@as SafeHouse | nil]]
             if temp == nil then
-                logger:error(
+                logger:error_server(
                     "Safehouse was nil while looping through the safehouse list.")
                 break
             end
@@ -104,7 +112,7 @@ Recipe.OnCanPerform[mod_constants.MOD_ID].ClaimVehicle = function (recipe, playe
         end
 
         if sq_dist == nil then
-            logger:debug("sq_dist was nil, even after safehouse loop.")
+            logger:debug_server("sq_dist was nil, even after safehouse loop.")
         end
 
         -- Is the player in the safehouse area?
@@ -118,8 +126,9 @@ Recipe.OnCanPerform[mod_constants.MOD_ID].ClaimVehicle = function (recipe, playe
         if sq_dist == nil
         or (sbvars.SafehouseDistance == 0 and in_safehouse_area == false)
         or (sbvars.SafehouseDistance > 0 and sq_dist > sbvars.SafehouseDistance) then
-            player:setHaloNote(getText(("IGUI_%s_HaloNote_NotInSafehouse")
-                :format(mod_constants.MOD_ID)))
+            player.setHaloNote(
+                getText(("IGUI_%s_HaloNote_NotInSafehouse"):format(mod_constants.MOD_ID)),
+                1, 0, 0, (128.0 * 4))
 
             perform = false
         end
@@ -150,9 +159,9 @@ Recipe.OnCreate[mod_constants.MOD_ID].ClaimVehicle = function (
     local generated_key = false
     if mdata.Parts == nil then
         if sbvars.DoAllowGeneratedPinkslips == false then
-            player:setHaloNote(
-                getText(("IGUI_%s_HaloNote_NoGeneratedPinkslips")
-                    :format(mod_constants.MOD_ID)))
+            player.setHaloNote(
+                getText(("IGUI_%s_HaloNote_NoGeneratedPinkslips"):format(mod_constants.MOD_ID)),
+                1, 0, 0, (128.0 * 4))
 
             return
         end
@@ -164,20 +173,20 @@ Recipe.OnCreate[mod_constants.MOD_ID].ClaimVehicle = function (
         local count = 1
         while true do
             if count >= 60 then
-                logger:error("Unable to select random vehicle due to timeout.")
+                logger:error_server("Unable to select random vehicle due to timeout.")
                 return
             end
 
             vehicle_name = vehicle_names:get(ZombRand(0, vehicle_names:size() - 1)) --[[@as string]]
             local name_lower = vehicle_name:lower()
-            logger:debug("Selecting random vehicle (%s).", vehicle_name)
+            logger:debug_server("Selecting random vehicle (%s).", vehicle_name)
 
             -- If vehicle not blacklisted, trailer, burnt, or smashed.
             if  blacklist.vehicle_blacklist.index[vehicle_name] == nil
             and name_lower:contains("trailer") == false
             and name_lower:contains("burnt") == false
             and name_lower:contains("smashed") == false then
-                logger:debug("Random vehicle selected.")
+                logger:debug_server("Random vehicle selected.")
                 break
             end
 
@@ -205,6 +214,7 @@ Recipe.OnCreate[mod_constants.MOD_ID].ClaimVehicle = function (
     args.Hotwired = mdata.Hotwired or nil
     args.Rust = mdata.Rust or nil
     args.Skin = mdata.Skin or nil
+    args.ModData = mdata.ModData or nil
 
     args.Blood = mdata.Blood and {
         F = mdata.Blood.F,

src/media/lua/shared/AoqiaCarwannaExtendedShared/mod_constants.lua

@@ -9,7 +9,7 @@ local logger = require("AoqiaZomboidUtilsShared/logger")
 local mod_constants = {}
 
 mod_constants.MOD_ID = "AoqiaCarwannaExtended"
-mod_constants.MOD_VERSION = "0.1.0"
+mod_constants.MOD_VERSION = "0.2.0"
 
 mod_constants.LOGGER = logger:new(mod_constants.MOD_ID)
 
@@ -78,6 +78,7 @@ mod_constants.FUELTANK_NAMES = { "500FuelTank", "1000FuelTank" }
 --- @field DoDynamicPinkslipWeight boolean
 --- @field PinkslipWeight float
 --- @field PinkslipLootBlacklist string
+--- @field DoUnassignInterior boolean
 --- Main Vehicle Stuff
 --- @field DoVehicleLoot boolean
 --- @field DoCanHotwire boolean
@@ -100,6 +101,7 @@ mod_constants.FUELTANK_NAMES = { "500FuelTank", "1000FuelTank" }
 --- @field DoZedLoot boolean
 --- @field ZedLootChance float
 --- Mod Compatibility
+--- @field DoCompatRvInteriors boolean
 --- @field DoCompatTsarMod boolean
 --- @field DoCompatUdderlyRespawn boolean
 --- @field DoCompatColorExperimental boolean

src/media/lua/shared/translate/EN/IG_UI_EN.txt

@@ -4,6 +4,7 @@ IGUI_EN = {
     IGUI_AoqiaCarwannaExtended_Pinkslip = "Pinkslip",
 
     IGUI_AoqiaCarwannaExtended_ConfirmText = "Convert %1 into a Pinkslip?",
+    IGUI_AoqiaCarwannaExtended_ConfirmInteriorWarning = "This vehicle's interior will be DELETED!",
 
     // IGUI_AoqiaCarwannaExtended_VehicleName = "Vehicle Name: %1",
     IGUI_AoqiaCarwannaExtended_VehicleSkin = "Body Style: %1",
@@ -19,4 +20,5 @@ IGUI_EN = {
     IGUI_AoqiaCarwannaExtended_HaloNote_NoGeneratedPinkslips = "Generated pinkslips are disabled!",
     IGUI_AoqiaCarwannaExtended_HaloNote_NotInSafehouse = "You are not in or near a safehouse!",
     IGUI_AoqiaCarwannaExtended_HaloNote_NotOutside = "You need to be outside to claim a vehicle!",
+    IGUI_AoqiaCarwannaExtended_HaloNote_NotOnGround = "You need to be on the ground to claim a vehicle!",
 }

src/media/lua/shared/translate/EN/Sandbox_EN.txt

@@ -17,7 +17,7 @@ Sandbox_EN = {
     Sandbox_AoqiaCarwannaExtended_DoRequiresAutoForm_tooltip = "Requires an AutoForm to convert vehicles to pinkslips.",
 
     Sandbox_AoqiaCarwannaExtended_DoKeepAutoForm = "Keep AutoForm",
-    Sandbox_AoqiaCarwannaExtended_DoKeepAutoForm_tooltip = "Lets the player keep the AutoForm instead of removing it from their inventory when creating a pinkslip.",
+    Sandbox_AoqiaCarwannaExtended_DoKeepAutoForm_tooltip = "Allows the player who claims a pinkslip to get the AutoForm used to create it.",
 
     Sandbox_AoqiaCarwannaExtended_DoAutoFormLoot = "Enable AutoForm Loot",
     Sandbox_AoqiaCarwannaExtended_DoAutoFormLoot_tooltip = "Adds the Auto Form to the loot tables.",
@@ -43,6 +43,9 @@ Sandbox_EN = {
     Sandbox_AoqiaCarwannaExtended_PinkslipLootBlacklist = "Pinkslip Blacklist",
     Sandbox_AoqiaCarwannaExtended_PinkslipLootBlacklist_tooltip = "A list of generated pinkslip vehicles that should never spawn naturally. <LINE> Example: Base.Van;Base.SUV",
 
+    Sandbox_AoqiaCarwannaExtended_DoUnassignInterior = "Unassign Interior",
+    Sandbox_AoqiaCarwannaExtended_DoUnassignInterior_tooltip = "With RV Interiors compatibility enabled, allows the pinkslip vehicle to not keep the interior assigned. <LINE> This does not delete the interior from the world itself!",
+
     /* Main Vehicle Stuff --------------------- */
     Sandbox_AoqiaCarwannaExtended_SeparatorMainVehicleStuff = "-------- Main Vehicle Stuff --------",
 
@@ -109,6 +112,9 @@ Sandbox_EN = {
     /* Mod Support Sandbox Options ------------ */
     Sandbox_AoqiaCarwannaExtended_SeparatorModSupport = "-------- Mod Support --------",
 
+    Sandbox_AoqiaCarwannaExtended_DoCompatRvInteriors = "RV Interiors Compatibility",
+    Sandbox_AoqiaCarwannaExtended_DoCompatRvInteriors_tooltip = "Provides compatibility with RV Interiors mod.",
+
     Sandbox_AoqiaCarwannaExtended_DoCompatTsarMod = "TsarLib 2.0 Compatibility",
     Sandbox_AoqiaCarwannaExtended_DoCompatTsawMod_tooltip = "Provides experimental support for TsarLib's vehicle modifications.",
 

src/media/lua/shared/translate/EN/Tooltip_EN.txt

@@ -3,6 +3,7 @@ Tooltip_EN = {
     Tooltip_AoqiaCarwannaExtended_Blacklisted = "This vehicle is blacklisted!",
     Tooltip_AoqiaCarwannaExtended_HasPassengers = "This vehicle has passengers!",
     Tooltip_AoqiaCarwannaExtended_Hotwired = "This vehicle is hotwired.",
+    Tooltip_AoqiaCarwannaExtended_PlayersInInterior = "There are players in the interior!",
 
     Tooltip_AoqiaCarwannaExtended_DoSafehouseOnly = "Can only be claimed in or near a safehouse protected area.",