Merge pull request YimMenu-Lua#129 from YimMenu-Lua/yimactions_ui_refactor

refactor(UI): refactor YimActions UI

Author: xesdoog

.github/workflows/translations.yml

@@ -37,5 +37,5 @@ jobs:
         git config user.name "github-actions[bot]"
         git config user.email "github-actions[bot]@users.noreply.github.com"
         git add SSV2/includes/lib/translations/
-        git diff --cached --quiet || git commit -m "feat(Translations): update translations"
+        git diff --cached --quiet || git commit -m "chore(Translations): update translations"
         git push

README.md

@@ -125,7 +125,7 @@ A full list of available features and their usage [can be found here](docs/Featu
 
 <div>
   <a href="https://discord.gg/RHBUxJ5Qhp">
-    <img height="96" width="192" alt="Discord" src="https://substackcdn.com/image/fetch/$s_!nfCP!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8a41e45e-aac9-44e5-8b69-55a81058ecbf_875x280.png">
+    <img height="64" width="192" alt="Discord" src="https://substackcdn.com/image/fetch/$s_!nfCP!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8a41e45e-aac9-44e5-8b69-55a81058ecbf_875x280.png">
   </a>
 </div>
 

SSV2/includes/backend.lua

@@ -8,20 +8,19 @@
 
 
 local PreviewService = require("includes.services.PreviewService")
-local function ClearPreview()
-	PreviewService:Clear()
-end
+local ClearPreview   = function() PreviewService:Clear() end
+
 
 ---@class BlipData
 ---@field handle integer
 ---@field owner integer
 ---@field alpha integer
 
----@enum eAPIVersion
-Enums.eAPIVersion = {
-	V1  = 1, -- YimMenu V1 (Lua54)
-	V2  = 2, -- YimLuaAPI (Lua 54)
-	L54 = 99, -- Mock environment (Lua54)
+---@enum eGameBranch
+Enums.eGameBranch   = {
+	LAGECY   = 1,
+	ENHANCED = 2,
+	MOCK     = 99,
 }
 
 ---@enum eBackendEvent
@@ -32,7 +31,7 @@ Enums.eBackendEvent = {
 }
 
 ---@enum eEntityType
-Enums.eEntityType = {
+Enums.eEntityType   = {
 	Invalid = -1,
 	Ped     = 1,
 	Vehicle = 2,
@@ -41,8 +40,8 @@ Enums.eEntityType = {
 
 -- Global Singleton.
 ---@class Backend
----@field private api_version eAPIVersion
-local Backend = {
+---@field private m_game_branch eGameBranch
+local Backend       = {
 	__version                = "",
 	target_build             = "",
 	target_version           = "",
@@ -79,28 +78,30 @@ local Backend = {
 		[Enums.eEntityType.Vehicle] = 15,
 		[Enums.eEntityType.Object]  = 35,
 	},
+	---@type table<string, fun(handle: handle): any>
+	FeatureEntityHandlers    = {}
 }
-Backend.__index = Backend
+Backend.__index     = Backend
 
 ---@param name string
 ---@param script_version string
 ---@param game_version? GAME_VERSION
 function Backend:init(name, script_version, game_version)
-	local api_ver       = self:GetAPIVersion()
-	self.api_version    = api_ver
+	local branch        = self:GetGameBranch()
+	self.m_game_branch  = branch
 	self.script_name    = name
 	self.__version      = script_version
-	self.target_build   = game_version and game_version[api_ver].build or "any"
-	self.target_version = game_version and game_version[api_ver].online or "any"
+	self.target_build   = game_version and game_version[branch].build or "any"
+	self.target_version = game_version and game_version[branch].online or "any"
 
-	require("includes.lib.compat").SetupEnv(self.api_version)
+	require("includes.lib.compat").SetupEnv(self.m_game_branch)
 	return self
 end
 
----@return eAPIVersion
-function Backend:GetAPIVersion()
-	if (self.api_version) then
-		return self.api_version
+---@return eGameBranch
+function Backend:GetGameBranch()
+	if (self.m_game_branch) then
+		return self.m_game_branch
 	end
 
 	if (not script or (type(script) ~= "table")) then
@@ -109,36 +110,37 @@ function Backend:GetAPIVersion()
 			error("Failed to load: Unknown or unsupported Lua environment.")
 		end
 
-		self.api_version = Enums.eAPIVersion.L54
-		return self.api_version
+		self.m_game_branch = Enums.eGameBranch.MOCK
+		return self.m_game_branch
 	end
 
 	if (type(script["run_in_callback"]) == "function") then
 		error("YimMenuV2 is not supported. If you want to run this script in GTA V Enhanced, download YimLuaAPI.")
 	end
 
 	if (not menu_event or not menu_event.Wndproc) then
-		error("Unknown or unsupported game branch.")
+		error("Unknown or unsupported API.")
 	end
 
-	local ylapi_func = _G["get_game_branch"]
-	if (type(ylapi_func) ~= "function") then
-		self.api_version = Enums.eAPIVersion.V1
-		return self.api_version
+	---@type (fun(): integer)?
+	local get_game_branch = _G["get_game_branch"]
+	if (type(get_game_branch) ~= "function") then
+		self.m_game_branch = Enums.eGameBranch.LAGECY
+		return self.m_game_branch
 	end
 
-	local branch = ylapi_func()
+	local branch = get_game_branch()
 	if (type(branch) ~= "number" or branch > 1) then
 		error("Failed to load: Unknown or unsupported game branch.")
 	end
 
-	self.api_version = branch + 1
-	return self.api_version
+	self.m_game_branch = branch + 1 -- Our own eGameBranch starts at 1 to make it compatible with Lua table indices. YimLuaAPI's naturally starts at 0
+	return self.m_game_branch
 end
 
 ---@return boolean
 function Backend:IsMockEnv()
-	return self:GetAPIVersion() == Enums.eAPIVersion.L54
+	return self:GetGameBranch() == Enums.eGameBranch.MOCK
 end
 
 ---@return boolean
@@ -274,18 +276,18 @@ function Backend:RemoveBlip(owner)
 	self.CreatedBlips[owner] = nil
 end
 
+---@param name string
+---@param callback fun(handle: handle): any
+function Backend:RegisterFeatureEntityHandler(name, callback)
+	self.FeatureEntityHandlers[name] = callback
+end
+
 ---@param handle integer
 function Backend:CheckFeatureEntities(handle)
-	if Decorator:ExistsOn(handle, "EntityForge") then
-		EntityForge:RemoveEntityByHandle(handle)
-	end
-
-	if Decorator:ExistsOn(handle, "BillionaireServices") then
-		BillionaireServices:RemoveEntityByHandle(handle)
-	end
-
-	if Decorator:ExistsOn(handle, "YimActions") then
-		YimActions.CompanionManager:RemoveCompanionByHandle(handle)
+	for featName, callback in pairs(self.FeatureEntityHandlers) do
+		if (Decorator:ExistsOn(handle, featName)) then
+			callback(handle)
+		end
 	end
 end
 

SSV2/includes/classes/Mutex.lua

@@ -29,6 +29,11 @@ function Mutex.new()
 	return setmetatable({ m_locked = false }, Mutex)
 end
 
+---@return boolean
+function Mutex:IsLocked()
+	return self.m_locked
+end
+
 function Mutex:Acquire()
 	while (self.m_locked) do
 		yield()

SSV2/includes/data/actions/animations.lua

@@ -3018,7 +3018,7 @@ return {
 		label = "Ride Dick In Car",
 		dict = "mini@prostitutes@sexlow_veh",
 		name = "low_car_sex_loop_female",
-		category = "NSFW",
+		category = "In-Vehicle",
 		playbackRate = 1.0,
 		blendInSpeed = 4.0,
 		blendOutSpeed = -4.0,
@@ -3033,7 +3033,7 @@ return {
 		label = "Give Head In Car",
 		dict = "anim@mini@prostitutes@sex@veh_vstr@",
 		name = "bj_loop_prostitute",
-		category = "NSFW",
+		category = "In-Vehicle",
 		playbackRate = 1.0,
 		blendInSpeed = 4.0,
 		blendOutSpeed = -4.0,
@@ -3048,7 +3048,7 @@ return {
 		label = "Receive Head In Car",
 		dict = "anim@mini@prostitutes@sex@veh_vstr@",
 		name = "bj_loop_male",
-		category = "NSFW",
+		category = "In-Vehicle",
 		playbackRate = 1.0,
 		blendInSpeed = 4.0,
 		blendOutSpeed = -4.0,

SSV2/includes/data/actions/scenarios.lua

@@ -104,7 +104,7 @@ return {
 		scenario = "WORLD_HUMAN_BUM_SLUMPED",
 	},
 	{
-		label = " HOBO Standing",
+		label = "HOBO Standing",
 		scenario = "WORLD_HUMAN_BUM_STANDING",
 	},
 	{

SSV2/includes/data/actions/types.lua

@@ -22,7 +22,8 @@
 ---@field rot vec3
 ---@field pos vec3
 ---@field delay float
----@field scale float
+---@field scale? float
+---@field bone? integer
 
 ---@class AnimSFX
 ---@field speechName string
@@ -96,7 +97,7 @@
 ---@field strf string?
 ---@field wanim string
 
----@alias ActionData AnimData | ScenarioData | SyncedSceneData | MovementClipsetData?
+---@alias ActionData AnimData | ScenarioData | SyncedSceneData | MovementClipsetData
 
 ---@class ActionCommandData
 ---@field type eActionType

SSV2/includes/data/pointers.lua

@@ -59,9 +59,9 @@ function MemoryBatch.new(name, ida_sig, callback)
 	}
 end
 
----@type table<eAPIVersion, array<MemoryBatch>>
+---@type table<eGameBranch, array<MemoryBatch>>
 local mem_batches <const> = {
-	[Enums.eAPIVersion.V1] = {
+	[Enums.eGameBranch.LAGECY] = {
 		MemoryBatch.new("ScriptGlobals", "48 8D 15 ? ? ? ? 4C 8B C0 E8 ? ? ? ? 48 85 FF 48 89 1D", function(ptr)
 			GPointers.ScriptGlobals = ptr:add(0x3):rip()
 		end),
@@ -94,7 +94,7 @@ local mem_batches <const> = {
 		-- 	GPointers.DynamicFuncs.BreakOffVehicleWheel = _G[func_name]
 		-- end),
 	},
-	[Enums.eAPIVersion.V2] = {
+	[Enums.eGameBranch.ENHANCED] = {
 		MemoryBatch.new("ScriptGlobals", "48 8B 8E B8 00 00 00 48 8D 15 ? ? ? ? 49 89 D8", function(ptr)
 			GPointers.ScriptGlobals = ptr:add(0x7):add(0x3):rip()
 		end),
@@ -110,10 +110,10 @@ local mem_batches <const> = {
 			GPointers.ScreenResolution.y = ptr:add(0x1E):add(0x4):rip():get_word()
 		end),
 	},
-	[Enums.eAPIVersion.L54] = { --[[dummy]] },
+	[Enums.eGameBranch.MOCK] = { --[[dummy]] },
 }
 
-local API_VERSON <const> = Backend:GetAPIVersion()
+local API_VERSON <const> = Backend:GetGameBranch()
 local batches = mem_batches[API_VERSON]
 for _, batch in ipairs(batches) do
 	PatternScanner:Add(batch.m_name, batch.m_pattern, batch.m_callback)