feat(vehicle): improve "keep wheels turned"

- Keep wheels turned no longer teleports you outside the vehicle.

Author: xesdoog

SSV2/includes/classes/CEntity.lua

@@ -63,6 +63,11 @@ function CEntity:IsValid()
 	return self.m_ptr and self.m_ptr:is_valid()
 end
 
+---@return uint64_t
+function CEntity:GetAddress()
+	return self.m_ptr:get_address()
+end
+
 ---@return eModelType
 function CEntity:GetModelType()
 	if not self:IsValid() then

SSV2/includes/classes/CVehicle.lua

@@ -48,6 +48,8 @@ local SubHandlingCtorMap <const> = {
 ---@field public m_current_gear pointer<int16_t>
 ---@field public m_top_gear pointer<int8_t>
 ---@field public m_engine_health pointer<float>
+---@field public m_steering_input pointer<float> // 0xD4 name might not correctly reflect what this actually is but this seems to store controller input (value is between 0.99 (left) .. -0.99 (right))
+---@field public m_current_steering pointer<float> 0xDC // actual wheel steer. Wr'll use it to rewrite last known wheel steer after exiting a vehicle in IV-Style Exit so we'll no longer need to teleport outside or patch CTaskVehicleExit
 ---@field public m_is_targetable pointer<byte> `bool`
 ---@field public m_door_lock_status pointer<uint32_t>
 ---@field public m_model_info_flags pointer<uint32_t>
@@ -106,11 +108,13 @@ function CVehicle:init(vehicle)
 	instance.m_deform_god                   = ptr:add(0x096C)
 	instance.m_is_targetable                = ptr:add(0x0AEE)
 	instance.m_door_lock_status             = ptr:add(0x13D0)
-	instance.m_water_damage                 = ptr:add(0xD8)
+	instance.m_water_damage                 = ptr:add(0x00D8)
 	instance.m_next_gear                    = ptr:add(0x0880)
 	instance.m_current_gear                 = ptr:add(0x0882)
 	instance.m_top_gear                     = ptr:add(0x0886)
 	instance.m_engine_health                = ptr:add(0x0910)
+	instance.m_steering_input               = ptr:add(0x09D4)
+	instance.m_current_steering             = ptr:add(0x09DC)
 	instance.m_model_info_flags             = instance.m_model_info:add(0x057C)
 	instance.m_mass                         = instance.m_handling_data:add(0x000C)
 	instance.m_initial_drag_coeff           = instance.m_handling_data:add(0x0010)
@@ -133,9 +137,9 @@ function CVehicle:init(vehicle)
 	instance.m_damage_flags                 = instance.m_handling_data:add(0x012C)
 	instance.m_wheel_scale                  = instance.m_model_info:add(0x048C)
 	instance.m_wheel_scale_rear             = instance.m_model_info:add(0x0490)
-	instance.m_wheels                       = atArray(ptr:add(0xC30), CWheel)
-	instance.m_num_wheels                   = ptr:add(0xC38):get_int()
-	instance.m_ride_height                  = ptr:add(0xC30):deref():add(0x07C)
+	instance.m_wheels                       = atArray(ptr:add(0x0C30), CWheel)
+	instance.m_num_wheels                   = ptr:add(0x0C38):get_int()
+	instance.m_ride_height                  = ptr:add(0x0C30):deref():add(0x07C)
 
 	return instance
 end

SSV2/includes/classes/CWheel.lua

@@ -110,9 +110,9 @@ Enums.eWheelConfigFlags = {
 ---@field m_unk_u8 pointer<uint8_t> // 0x20A
 ---@field m_tyre_is_burst pointer<bool> // 0x20B
 ---@field m_unk_byte pointer<byte> // 0x20C
----@field m_has_hydraulics pointer<bool> // 0x20D // true for cars with DUNK mod
+---@field m_has_hydraulics pointer<bool> // 0x20D // true for cars with DONK mod
 ---@overload fun(addr: pointer): CWheel|nil
-local CWheel = { m_size = 0x1FC }
+local CWheel = { m_size = 0x20E }
 CWheel.__index = CWheel
 CWheel.__type = "CWheel"
 setmetatable(CWheel, {

SSV2/includes/features/vehicle/iv_style_exit.lua

@@ -6,6 +6,9 @@ local FeatureBase = require("includes.modules.FeatureBase")
 ---@field private m_entity PlayerVehicle
 ---@field private m_triggered boolean
 ---@field private m_timer Time.Timer
+---@field private m_steering_timer Time.Timer
+---@field private m_pending_steering boolean
+---@field private m_last_steer_angle float
 local IVStyleExit = setmetatable({}, FeatureBase)
 IVStyleExit.__index = IVStyleExit
 
@@ -17,9 +20,13 @@ function IVStyleExit.new(pv)
 end
 
 function IVStyleExit:Init()
-	self.m_triggered = false
-	self.m_timer = Timer.new(1000)
+	self.m_triggered        = false
+	self.m_pending_steering = false
+	self.m_last_steer_angle = 0.0
+	self.m_steering_timer   = Timer.new(200)
+	self.m_timer            = Timer.new(1000)
 	self.m_timer:pause()
+	self.m_steering_timer:pause()
 end
 
 function IVStyleExit:ShouldRun()
@@ -39,39 +46,51 @@ function IVStyleExit:Cleanup()
 	self.m_timer:pause()
 end
 
+function IVStyleExit:ShouldReapplySteering()
+	local fVal = math.abs(self.m_last_steer_angle)
+	return fVal ~= 0 and fVal < 1 and fVal > 0.001
+end
+
 ---@param keepEngineOn boolean
 function IVStyleExit:LeaveVehicle(keepEngineOn)
 	local vehHandle = self.m_entity:GetHandle()
-	local leftPressed = PAD.IS_CONTROL_PRESSED(0, 34)
-	local rightPressed = PAD.IS_CONTROL_PRESSED(0, 35)
-	local enabled = GVars.features.vehicle.no_wheel_recenter and self.m_entity:IsCar() and (leftPressed or rightPressed)
+	local enabled   = GVars.features.vehicle.no_wheel_recenter and self.m_entity:IsCar()
 	Self:SetConfigFlag(Enums.ePedConfigFlags.LeaveEngineOnWhenExitingVehicles, keepEngineOn)
 
-	if (enabled and not keepEngineOn) then
-		VEHICLE.SET_VEHICLE_ENGINE_ON(self.m_entity:GetHandle(), false, true, false)
+	if (enabled) then
+		self.m_last_steer_angle = self.m_entity:Resolve().m_current_steering:get_float()
+		if (not keepEngineOn) then
+			VEHICLE.SET_VEHICLE_ENGINE_ON(self.m_entity:GetHandle(), false, true, false)
+		end
+	end
+
+	TASK.TASK_LEAVE_VEHICLE(Self:GetHandle(), vehHandle, 0)
+
+	if (self:ShouldReapplySteering()) then
+		self.m_pending_steering = true
+		self.m_steering_timer:reset()
+		self.m_steering_timer:resume()
 	end
-	TASK.TASK_LEAVE_VEHICLE(Self:GetHandle(), vehHandle, enabled and 16 or 0) -- 16=tp outside. goofy because I don't feel like patching memory 🤷‍♂️
+
 	self:Cleanup()
 end
 
 function IVStyleExit:Update()
 	PAD.DISABLE_CONTROL_ACTION(0, 75, true)
 
-	local exitPressed = PAD.IS_DISABLED_CONTROL_PRESSED(0, 75)
-	if (exitPressed) then
+	if (PAD.IS_DISABLED_CONTROL_PRESSED(0, 75)) then
 		if (self.m_entity:GetSpeed() > 15) then
 			TASK.TASK_LEAVE_VEHICLE(Self:GetHandle(), self.m_entity:GetHandle(), 4160)
 			self:Cleanup()
 			return
 		end
 
-		if (not GVars.features.vehicle.iv_exit) then
+		if (not GVars.features.vehicle.iv_exit and not self.m_triggered) then
 			self:LeaveVehicle(false)
-			return
 		end
 
-		self.m_timer:resume()
 		self.m_triggered = true
+		self.m_timer:resume()
 	end
 
 	if (self.m_triggered) then
@@ -80,8 +99,19 @@ function IVStyleExit:Update()
 		elseif (PAD.IS_DISABLED_CONTROL_PRESSED(0, 75) and self.m_timer:is_done()) then
 			self:LeaveVehicle(false)
 		end
+	end
+
+	if (self.m_pending_steering) then
+		local veh = self.m_entity
+		if (veh and veh:IsValid()) then
+			local pSteering = veh:Resolve().m_current_steering
+			pSteering:set_float(self.m_last_steer_angle)
+		end
 
-		return
+		if (self.m_steering_timer:is_done()) then
+			self.m_pending_steering = false
+			self.m_last_steer_angle = 0.0
+		end
 	end
 
 	if (self.m_triggered and not Self:IsDriving()) then

SSV2/includes/lib/translations/de-DE.lua

@@ -425,7 +425,7 @@ return {
 	["VEH_RALLY_TYRES"] = "Rallye-Reifen",
 	["VEH_OFFROAD_ABILITIES_TT"] = "Erhöht die Offroad-Fähigkeiten Ihres Fahrzeugs.",
 	["VEH_RALLY_TYRES_TT"] = "Rüstet Ihr Fahrzeug mit Rallye-Reifen aus, die das Handling im Gelände weiter verbessern.",
-	["SELF_LASER_SIGHTS_TT"] = "Ermöglicht Laservisiere für Ihre Schusswaffen. Sie können die Visiere ein- und ausschalten, indem Sie [%s] drücken.",
+	["SELF_LASER_SIGHTS_TT"] = "Ermöglicht Laservisiere für Ihre Schusswaffen.",
 	["VEH_FORCE_NO_TC_TT"] = "Nur Fahrräder: Zwingt Ihr Fahrzeug dazu, keine Traktionskontrolle zu haben, sodass Sie mit Fahrrädern driften und ins Schleudern geraten können.",
 	["VEH_LOW_SPEED_WHEELIE_TT"] = "Nur Fahrräder: Ermöglicht Ihnen, Wheelies bei sehr niedrigen Geschwindigkeiten zu machen, ähnlich wie beim „Manchez“.",
 	["VEH_LOW_SPEED_WHEELIE"] = "Low-Speed-Wheelie",

SSV2/includes/lib/translations/en-US.lua

@@ -312,8 +312,7 @@ return {
 	"This feature does not auto-aim or auto-fire. It simply remembers the last ped you aimed at and redirects your shot to that ped when you fire, even if you shoot elsewhere. The target resets when you stop aiming.",
 	["SELF_LASER_SIGHTS"]                  = "Laser Sights",
 	["SELF_LASER_SIGHTS_LENGTH"]           = "Laser Ray Length",
-	["SELF_LASER_SIGHTS_TT"]               =
-	"Enables laser sights on your firearms. You can toggle the sights on and off by pressing [%s]", -- hopefully the keybind's name gets formatted across locales
+	["SELF_LASER_SIGHTS_TT"]               = "Enables laser sights on your firearms.",
 	["SELF_LASER_SIGHTS_COL"]              = "Laser Color",
 	["SELF_KATANA"]                        = "Katana",
 	["SELF_KATANA_TT"]                     = "Replaces one of four melee weapon models of your choosing with a Katana.",

SSV2/includes/lib/translations/es-ES.lua

@@ -414,7 +414,7 @@ return {
 	["GENERIC_CLEAR"] = "Claro",
 	["SUBTAB_HANDLING_EDITOR"] = "Editor de manejo",
 	["SELF_LASER_SIGHTS"] = "Miras láser",
-	["SELF_LASER_SIGHTS_TT"] = "Habilita miras láser en sus armas de fuego. Puedes activar y desactivar las miras presionando [%s]",
+	["SELF_LASER_SIGHTS_TT"] = "Habilita miras láser en sus armas de fuego.",
 	["SELF_LASER_SIGHTS_LENGTH"] = "Longitud del rayo láser",
 	["SELF_LASER_SIGHTS_COL"] = "Color láser",
 	["VEH_NO_ENGINE_BRAKE_TT"] = "Te permite deslizarte cuando no pisas el acelerador sin perder tanta velocidad.",

SSV2/includes/lib/translations/fr-FR.lua

@@ -422,7 +422,7 @@ return {
 	["VEH_OFFROAD_ABILITIES"] = "Capacités tout-terrain",
 	["VEH_OFFROAD_ABILITIES_TT"] = "Augmente les capacités tout-terrain de votre véhicule.",
 	["VEH_KERS_BOOST_TT"] = "Équipe votre véhicule du boost KERS (Kinetic Energy Recovery System), similaire aux voitures de F1.",
-	["SELF_LASER_SIGHTS_TT"] = "Permet des vues laser sur vos armes à feu. Vous pouvez activer et désactiver les viseurs en appuyant sur [%s]",
+	["SELF_LASER_SIGHTS_TT"] = "Permet des vues laser sur vos armes à feu.",
 	["SUBTAB_HANDLING_EDITOR"] = "Éditeur de manipulation",
 	["SELF_LASER_SIGHTS_COL"] = "Couleur laser",
 	["VEH_FORCE_NO_TC_TT"] = "Vélos uniquement : oblige votre véhicule à ne pas avoir de contrôle de traction, ce qui vous permet de faire des dérives et des dérapages avec des vélos.",

SSV2/includes/lib/translations/it-IT.lua

@@ -427,7 +427,7 @@ return {
 	["SELF_LASER_SIGHTS_LENGTH"] = "Lunghezza del raggio laser",
 	["VEH_LOW_SPEED_WHEELIE"] = "Impennata a bassa velocità",
 	["VEH_RALLY_TYRES"] = "Pneumatici Rally",
-	["SELF_LASER_SIGHTS_TT"] = "Abilita i mirini laser sulle tue armi da fuoco. Puoi attivare e disattivare la vista premendo [%s]",
+	["SELF_LASER_SIGHTS_TT"] = "Abilita i mirini laser sulle tue armi da fuoco.",
 	["VEH_OFFROAD_ABILITIES_TT"] = "Aumenta le capacità fuoristrada del tuo veicolo.",
 	["VEH_ROCKET_BOOST"] = "Spinta del razzo",
 	["VEH_ROCKET_BOOST_TT"] = "Dota il tuo veicolo di un razzo potenziato, simile al \"Vigilante\".",

SSV2/includes/lib/translations/ja-JP.lua

@@ -423,7 +423,7 @@ return {
 	["VEH_RALLY_TYRES"] = "ラリータイヤ",
 	["VEH_OFFROAD_ABILITIES"] = "オフロード能力",
 	["VEH_FORCE_NO_TC_TT"] = "バイクのみ: 車両にトラクション コントロールを強制的に無効にし、バイクでドリフトやスキッドを行うことができます。",
-	["SELF_LASER_SIGHTS_TT"] = "銃器のレーザー照準器を有効にします。 [%s] を押すと照準器のオンとオフを切り替えることができます。",
+	["SELF_LASER_SIGHTS_TT"] = "銃器のレーザー照準器を有効にします。",
 	["VEH_RALLY_TYRES_TT"] = "車両にラリータイヤを装備すると、オフロードでのハンドリングがさらに向上します。",
 	["VEH_NO_ENGINE_BRAKE"] = "エンジンブレーキを無効にする",
 	["VEH_KERS_BOOST"] = "KERSブースト",