Merge branch 'dev'

Author: aoqia194

CHANGELOG.md

@@ -5,6 +5,31 @@ 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).
 
+## [1.1.0] - 2025-02-18
+
+### Added
+
+- Separate moveable parking meters.
+
+## [1.0.1] - 2025-02-18
+
+### Fixed
+
+- Not checking if player is near a parking meter for using pinkslips.
+
+## [1.0.0] - 2025-02-12
+
+### Added
+
+-   Pinkslip item hover details
+-   Parking meter tile for creating and using pinkslips
+
+## [0.4.2] - 2024-12-01
+
+### Fixed
+
+-   Vehicle spawning above level 0 (engine limitation).
+
 ## [0.4.1] - 2024-11-21
 
 ### Fixed

CREDITS.md LICENSED_CONTENT.mdCREDITS.md renamed to LICENSED_CONTENT.md

@@ -1,6 +1,6 @@
-# Credits
+# Licensed Content
 
-### 3rd Party Assets
+### 3rd-party sounds
 - The following sounds are used under the Mixkit Sound Effects Free License
 mixkit-fast-signing-with-a-pen-2370
 mixkit-signing-on-a-paper-2368

README.md

@@ -1,7 +1,17 @@
 # AoqiaCarwannaExtended
 
-TODO.
-This is a COMPLETE rewrite of the mod, meaning pretty much none of your old sandbox options will be compatible. I am unsure as to how compatible the saves will be, as I removed a lot of unnecessary pinkslip items; a Pinkslip item for every vehicle in the game including modded ones are now no longer needed.
+This mod is a COMPLETE ground-up rewrite of the original, meaning none of your old pinkslip items and sandbox options are compatible with this version. I removed a lot of unnecessary pinkslip items, so a pinkslip item for every vehicle in the game including modded ones are now no longer needed.
+
+This mod does not and will not support Build 42 until a stable multiplayer revision is released, or Build 42 becomes a stable release itself. I do not have the time to constantly change and micro-manage the mod just because Build 42 decides to change it's script schema or Lua API for the 500th time in a month.
+
+## Features
+
+-   All base functionality from the original mod
+-   More sandbox options to tweak
+-   Safehouse claiming protection (in or near)
+-   Custom Parking Stall tile for pinkslip claiming
 
 # Credits
-- The original CarWanna mod by Xyberviri.
+
+-   The original CarWanna mod by Xyberviri.
+-   Alex for the parking meter tile commission.

src/media/AoqiaCarwannaExtended.tiles

@@ -32,7 +32,9 @@ function create_pinkslip:is_part_missing(part)
 end
 
 function create_pinkslip:isValid()
-    return self.vehicle and self.vehicle:isRemovedFromWorld() == false
+    return self.vehicle
+        and self.vehicle:isRemovedFromWorld() == false
+        and getPlayer():getZ() == 0
 end
 
 function create_pinkslip:waitToStart()
@@ -72,17 +74,11 @@ function create_pinkslip:perform()
         pinkslip:setWeight(self.vehicle:getWeight())
     end
 
-    local mdata = pinkslip:getModData() --[[@as ModDataDummy]]
-
     -- Make sure the table exists in the pinkslip.
-    local sub_mdata = nil --[[@as ModDataDummy | nil]]
-    if mdata and mdata[mod_constants.MOD_ID] == nil then
-        mdata[mod_constants.MOD_ID] = {}
-        sub_mdata = mdata[mod_constants.MOD_ID]
-    end
-
-    if sub_mdata == nil then
-        logger:warn("Pinkslip sub_mdata failed to create/retrieve. THIS IS SO BAD!!!")
+    --- @type ModDataDummy | nil
+    local mdata = aoqia_table.init_mdata(pinkslip, mod_constants.MOD_ID)
+    if mdata == nil then
+        logger:warn("Pinkslip mdata failed to create/retrieve. THIS IS SO BAD!!!")
         return
     end
 
@@ -96,44 +92,44 @@ function create_pinkslip:perform()
     end
 
     if veh_mdata and has_mdata then
-        sub_mdata.ModData = aoqia_table.shallow_copy(veh_mdata)
+        mdata.ModData = aoqia_table.shallow_copy(veh_mdata)
     end
 
-    if sub_mdata.Parts and sub_mdata.Parts.index and sub_mdata.Parts.values then
-        sub_mdata.Parts = sub_mdata.Parts
+    if mdata.Parts and mdata.Parts.index and mdata.Parts.values then
+        mdata.Parts = mdata.Parts
     else
         --- @diagnostic disable-next-line: assign-type-mismatch
-        sub_mdata.Parts = { index = {}, values = {} }
+        mdata.Parts = { index = {}, values = {} }
     end
 
-    sub_mdata.Blood = sub_mdata.Blood or {}
-    sub_mdata.Color = sub_mdata.Color or {}
-
-    sub_mdata.Blood.F = self.vehicle:getBloodIntensity("Front")
-    sub_mdata.Blood.B = self.vehicle:getBloodIntensity("Rear")
-    sub_mdata.Blood.L = self.vehicle:getBloodIntensity("Left")
-    sub_mdata.Blood.R = self.vehicle:getBloodIntensity("Right")
-    sub_mdata.Color.H = self.vehicle:getColorHue()
-    sub_mdata.Color.S = self.vehicle:getColorSaturation()
-    sub_mdata.Color.V = self.vehicle:getColorValue()
-    sub_mdata.EngineLoudness = self.vehicle:getEngineLoudness()
-    sub_mdata.EnginePower = self.vehicle:getEnginePower()
-    sub_mdata.EngineQuality = self.vehicle:getEngineQuality()
-    sub_mdata.HasKey = self.vehicle:isKeysInIgnition()
-    sub_mdata.HeadlightsActive = self.vehicle:getHeadlightsOn()
-    sub_mdata.Hotwired = self.vehicle:isHotwired()
-    sub_mdata.Skin = self.vehicle:getSkinIndex()
-    sub_mdata.Rust = self.vehicle:getRust()
-    sub_mdata.FullType = vehicle_script:getFullName()
-    sub_mdata.Name = vehicle_name
+    mdata.Blood = mdata.Blood or {}
+    mdata.Color = mdata.Color or {}
+
+    mdata.Blood.F = self.vehicle:getBloodIntensity("Front")
+    mdata.Blood.B = self.vehicle:getBloodIntensity("Rear")
+    mdata.Blood.L = self.vehicle:getBloodIntensity("Left")
+    mdata.Blood.R = self.vehicle:getBloodIntensity("Right")
+    mdata.Color.H = self.vehicle:getColorHue()
+    mdata.Color.S = self.vehicle:getColorSaturation()
+    mdata.Color.V = self.vehicle:getColorValue()
+    mdata.EngineLoudness = self.vehicle:getEngineLoudness()
+    mdata.EnginePower = self.vehicle:getEnginePower()
+    mdata.EngineQuality = self.vehicle:getEngineQuality()
+    mdata.HasKey = self.vehicle:isKeysInIgnition()
+    mdata.HeadlightsActive = self.vehicle:getHeadlightsOn()
+    mdata.Hotwired = self.vehicle:isHotwired()
+    mdata.Skin = self.vehicle:getSkinIndex()
+    mdata.Rust = self.vehicle:getRust()
+    mdata.FullType = vehicle_script:getFullName()
+    mdata.Name = vehicle_name
 
     local key = player_inventory:haveThisKeyId(self.vehicle:getKeyId())
-    if key and sub_mdata.HasKey == false then
-        sub_mdata.MakeKey = true
+    if key and mdata.HasKey == false then
+        mdata.MakeKey = true
         player_inventory:Remove(key --[[@as string]])
     end
 
-    local parts = sub_mdata.Parts
+    local parts = mdata.Parts
     -- Should never happen~
     if parts == nil then return end
 
@@ -251,8 +247,8 @@ function create_pinkslip:perform()
     logger:debug("Vehicle part item weights combined: (%d)", weight)
     logger:debug("Total vehicle weight calculated: (%d)", weight + vehicle_script:getMass())
 
-    sub_mdata.PartsDamaged = damaged_parts
-    sub_mdata.PartsMissing = missing_parts
+    mdata.PartsDamaged = damaged_parts
+    mdata.PartsMissing = missing_parts
 
     -- Remove form item if required.
     if sbvars.DoRequiresAutoForm then

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

@@ -1,8 +1,9 @@
--- -------------------------------------------------------------------------- --
---                                    wawa                                    --
--- -------------------------------------------------------------------------- --
+-- -------------------------------------------- --
+-- PINKSLIP CLAIM UI                            --
+-- -------------------------------------------- --
 
 -- My requires.
+local aoqia_table = require("AoqiaZomboidUtilsShared/table")
 local constants = require("AoqiaZomboidUtilsShared/constants")
 local create_pinkslip = require("AoqiaCarwannaExtendedClient/actions/create_pinkslip")
 local mod_constants = require("AoqiaCarwannaExtendedShared/mod_constants")
@@ -12,9 +13,7 @@ require("luautils")
 
 -- std globals.
 local math = math
-local table = table
 -- TIS globals.
-local getSquare = getSquare
 local getText = getText
 local ISModalRichText = ISModalRichText
 local ISTimedActionQueue = ISTimedActionQueue
@@ -68,19 +67,13 @@ function pinkslip.confirm_dialog(player, vehicle)
 
     local player_num = player:getPlayerNum()
 
-    local interior_warning = nil
-    if  sbvars.DoCompatRvInteriors and sbvars.DoUnassignInterior
-    and RVInterior and RVInterior.vehicleHasInteriorParameters(vehicle) then
-        interior_warning = getText(("IGUI_%s_ConfirmInteriorWarning"):format(mod_constants.MOD_ID))
-    end
+    local interior_warning = ((sbvars.DoCompatRvInteriors and sbvars.DoUnassignInterior
+            and RVInterior and RVInterior.vehicleHasInteriorParameters(vehicle)) and
+        getText(("IGUI_%s_ConfirmInteriorWarning"):format(mod_constants.MOD_ID)) or "")
 
     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
+        .. ((interior_warning ~= "") and (" <LINE> <RGB:1,0,0> " .. interior_warning) or "")
 
     local modal = ISModalRichText:new(
         0,
@@ -104,8 +97,7 @@ function pinkslip.add_option_to_menu(player, context, vehicle)
     local sbvars = SandboxVars[mod_constants.MOD_ID] --[[@as SandboxVarsDummy]]
     if sbvars.DoRegistration == false then return end
 
-    local mdata = vehicle:getModData() --[[@as ModDataDummy]]
-
+    local mdata = aoqia_table.init_mdata(vehicle, mod_constants.MOD_ID) --[[@as ModDataDummy]]
     local player_inv = player:getInventory()
 
     local vehicle_script = vehicle:getScript()
@@ -363,10 +355,54 @@ function pinkslip.add_option_to_menu(player, context, vehicle)
             "adding option failed: Vehicle blacklisted from pinkslip use.")
     end
 
-    -- If safehouse only.
-    if constants.IS_SINGLEPLAYER == false and sbvars.DoSafehouseOnly then
-        local username = player:getUsername()
+    if not_available == false and sbvars.DoParkingMeterOnly then
+        local found_meter = false
+
+        local sq = vehicle:getSquare()
+        local sq_x = sq:getX()
+        local sq_y = sq:getY()
+
+        local dist = math.ceil(sbvars.ParkingMeterDistance / 2)
+        for x = sq_x - dist, sq_x + dist do
+            for y = sq_y - dist, sq_y + dist do
+                repeat
+                    local s = getSquare(x, y, 0)
+                    if s == nil then break end
+
+                    local s_objs = s:getObjects()
+                    for i = 1, s_objs:size() do
+                        local obj = s_objs:get(i - 1) --[[@as IsoObject]]
+                        local obj_name = obj:getSprite():getName()
+                        if obj_name == "f_parkingmeters_01_0"
+                        or obj_name == "f_parkingmeters_01_1"
+                        or obj_name == "f_parkingmeters_01_2"
+                        or obj_name == "f_parkingmeters_01_3"
+                        or obj_name == "f_parkingmeters_01_4"
+                        or obj_name == "f_parkingmeters_01_5"
+                        or obj_name == "f_parkingmeters_01_6"
+                        or obj_name == "f_parkingmeters_01_7" then
+                            found_meter = true
+                            break
+                        end
+                    end
+                until true
+            end
+
+            if found_meter then break end
+        end
+
+        if found_meter == false then
+            text = text
+                .. " <LINE> <LINE> <RGB:1,0,0> "
+                .. getText(("Tooltip_%s_NoParkingMeterFound"):format(mod_constants.MOD_ID))
+            not_available = true
+        end
+    end
 
+    if not_available == false and constants.IS_SINGLEPLAYER == false and sbvars.DoSafehouseOnly then
+        local found_safehouse = false
+
+        local username = player:getUsername()
         local veh_sq = vehicle:getSquare()
         local veh_sq_x = veh_sq:getX()
         local veh_sq_y = veh_sq:getY()
@@ -439,9 +475,15 @@ 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
+            found_safehouse = false
+        else
+            found_safehouse = true
+        end
+
+        if found_safehouse == false then
             text = text
                 .. " <LINE> <LINE> <RGB:1,0,0> "
-                .. getText(("Tooltip_%s_DoSafehouseOnly"):format(mod_constants.MOD_ID))
+                .. getText(("Tooltip_%s_NoSafehouseFound"):format(mod_constants.MOD_ID))
             not_available = true
         end
     end
@@ -476,6 +518,14 @@ function pinkslip.add_option_to_menu(player, context, vehicle)
         not_available = true
     end
 
+    -- If the player is above Z level 0.
+    if player:getZ() > 0 then
+        text = text
+            .. "<LINE> <LINE> <RGB:1,0,0> "
+            .. getText(("Tooltip_%s_AboveZLevel"):format(mod_constants.MOD_ID))
+        not_available = true
+    end
+
     -- Do admin override if enabled.
     if  not_available
     and player:getAccessLevel() == "Admin"