chore: tidy up for weekly release

- Fix formatting.
- SGSL: Add caching by reference.
- YimActions: Fix when actions are allowed to be added to history.
- CI: Another attempt at fixing release workflow glob issue. STOP INCLUDING THE /dev FOLDER!

Author: xesdoog

.github/workflows/zip-release.yml

@@ -172,8 +172,9 @@ jobs:
       uses: thedoctor0/zip-release@0.7.6
       with:
         type: 'zip'
-        filename: "Samurais_Scripts_${{ steps.increment_tag.outputs.version_number }}.zip"
-        exclusions: /.git* /dev* /docs* **.json **.md **.editorconfig **.py **.txt *.ps1 .gitignore LICENSE
+        path: './SSV2'
+        filename: 'Samurais_Scripts_${{ steps.increment_tag.outputs.version_number }}.zip'
+        exclusions: '**/*.json **/*.md **/*.editorconfig **/*.py **/*.txt **/*.ps1 **/*.gitignore'
 
     - name: Upload Release
       if: steps.check_changes.outputs.should_proceed == 'true'

SSV2/includes/data/yrv3_data.lua

@@ -130,7 +130,7 @@ local RawBusinessData <const> = {
 				if (tunables.get_int("EXEC_SELL_COOLDOWN") > 0) then
 					tunables.set_int("EXEC_SELL_COOLDOWN", 0)
 				end
-				if tunables.get_int("EXEC_SELL_FAIL_COOLDOWN") > 0 then
+				if (tunables.get_int("EXEC_SELL_FAIL_COOLDOWN") > 0) then
 					tunables.set_int("EXEC_SELL_FAIL_COOLDOWN", 0)
 				end
 			end

SSV2/includes/features/extra/yim_actions/YimActionsV3.lua

@@ -202,13 +202,14 @@ function YimActions:InitInVehicleAnim(animData, targetPed)
 	return true
 end
 
+---@nodiscard
 ---@param animData AnimData
 ---@param targetPed? handle
+---@return boolean
 function YimActions:PlayAnim(animData, targetPed)
 	targetPed = self:GetPed(targetPed)
-
 	if (animData.category == "In-Vehicle" and not self:InitInVehicleAnim(animData, targetPed)) then
-		return
+		return false
 	end
 
 	TaskWait(Game.RequestAnimDict, animData.dict)
@@ -226,8 +227,6 @@ function YimActions:PlayAnim(animData, targetPed)
 		false
 	)
 
-	self:UpdatePlayHistory(targetPed)
-
 	if (not GVars.features.yim_actions.disable_props) then
 		if (animData.props and #animData.props > 0) then
 			self.m_prop_mgr:AttachProp(targetPed, animData.props)
@@ -244,29 +243,32 @@ function YimActions:PlayAnim(animData, targetPed)
 
 	local isLooped = Bit.IsBitSet(animData.flags, Enums.eAnimFlags.LOOPING)
 	local isFrozen = Bit.IsBitSet(animData.flags, Enums.eAnimFlags.HOLD_LAST_FRAME)
-
 	if (not isLooped and not isFrozen) then
-		repeat
-			yield()
-		until self:IsAnimDone(targetPed, animData)
-		self.CurrentlyPlaying[targetPed] = nil
+		ThreadManager:Run(function(s)
+			while (not self:IsAnimDone(targetPed, animData)) do
+				s:yield()
+			end
+			self.CurrentlyPlaying[targetPed] = nil
+		end)
 	end
+
+	return true
 end
 
+---@nodiscard
 ---@param scenarioData ScenarioData
 ---@param targetPed? handle
 ---@param playImmediately? boolean
+---@return boolean
 function YimActions:PlayScenario(scenarioData, targetPed, playImmediately)
 	targetPed = self:GetPed(targetPed)
-
-	if scenarioData.label == "Cook On BBQ" then
+	if (scenarioData.label == "Cook On BBQ") then
 		local offsetCoords = ENTITY.GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS(
 			targetPed,
 			0.0,
 			1.0,
 			0.0
 		)
-
 		local bbq = self.m_prop_mgr:SpawnProp(
 			targetPed,
 			{ model = 286252949 },
@@ -276,13 +278,12 @@ function YimActions:PlayScenario(scenarioData, targetPed, playImmediately)
 			true,
 			true
 		)
-
-		if bbq and bbq ~= 0 then
+		if (bbq and bbq ~= 0) then
 			ENTITY.SET_ENTITY_HEADING(bbq, Game.GetHeading(bbq) - 180)
 		end
 	end
 
-	if self:IsPedPlaying(targetPed) then
+	if (self:IsPedPlaying(targetPed)) then
 		TASK.CLEAR_PED_TASKS_IMMEDIATELY(targetPed) -- avoid scenario exit anims if we start a scenario while already playing one
 	end
 
@@ -292,11 +293,16 @@ function YimActions:PlayScenario(scenarioData, targetPed, playImmediately)
 		-1,
 		not playImmediately
 	)
+
+	return true
 end
 
+---@nodiscard
 ---@param data SyncedSceneData
+---@return boolean
 function YimActions:PlaySyncedScene(data)
 	self.m_scene_mgr:Play(data)
+	return true
 end
 
 ---@param action? Action
@@ -320,22 +326,23 @@ function YimActions:Play(action, ped)
 	TaskWait(function() return self.CurrentlyPlaying[ped] == nil end)
 
 	self.CurrentlyPlaying[ped] = action
+	local success = false
 
+	---@diagnostic disable: param-type-mismatch
 	if (action.action_type == Enums.eActionType.SCENARIO) then
-		---@diagnostic disable-next-line
-		self:PlayScenario(action.data, ped)
+		success = self:PlayScenario(action.data, ped)
 	elseif action.action_type == Enums.eActionType.ANIM then
-		---@diagnostic disable-next-line
-		self:PlayAnim(action.data, ped)
+		success = self:PlayAnim(action.data, ped)
 	elseif action.action_type == Enums.eActionType.SCENE then
-		---@diagnostic disable-next-line
-		self:PlaySyncedScene(action.data)
+		success = self:PlaySyncedScene(action.data)
 	end
+	---@diagnostic enable: param-type-mismatch
 
-	self:UpdatePlayHistory(ped)
-
-	if (Backend.debug_mode) then
-		self.Debugger:Update(ped)
+	if (success) then
+		self:UpdatePlayHistory(ped)
+		if (Backend.debug_mode) then
+			self.Debugger:Update(ped)
+		end
 	end
 end
 

SSV2/includes/features/online/CasinoPacino.lua

@@ -190,29 +190,24 @@ function CasinoPacino:SetPokerCards(player_id, players_current_table, card_one,
 	local three_card_poker_deck_size       = SGSL:Get(SGSL.data.three_card_poker_deck_size):GetValue()
 	local three_card_poker_anti_cheat      = tcp_ac_obj:GetValue()
 	local three_card_poker_anti_cheat_deck = tcp_ac_obj:GetOffset(1)
-
-
-	local TCPCards = ScriptLocal(three_card_poker_cards, "three_card_poker")
+	local TCPCards                         = ScriptLocal(three_card_poker_cards, "three_card_poker")
 		:At(three_card_poker_current_deck)
 		:At(1)
 		:At(players_current_table * three_card_poker_deck_size)
 		:At(2)
 
-	local TCPAC    = ScriptLocal(three_card_poker_anti_cheat, "three_card_poker")
+	local TCPAC                            = ScriptLocal(three_card_poker_anti_cheat, "three_card_poker")
 		:At(three_card_poker_anti_cheat_deck)
 		:At(1)
 		:At(1)
 		:At(players_current_table * three_card_poker_deck_size)
 
 
-	TCPCards:At(1):At(player_id * 3):WriteInt(card_one)
-	TCPAC:At(1):At(player_id * 3):WriteInt(card_one)
-
-	TCPCards:At(2):At(player_id * 3):WriteInt(card_two)
-	TCPAC:At(2):At(player_id * 3):WriteInt(card_two)
-
-	TCPCards:At(3):At(player_id * 3):WriteInt(card_three)
-	TCPAC:At(3):At(player_id * 3):WriteInt(card_three)
+	local base = player_id * 3
+	for i, card in ipairs({ card_one, card_two, card_three }) do
+		TCPCards:At(i):At(base):WriteInt(card)
+		TCPAC:At(i):At(base):WriteInt(card)
+	end
 end
 
 function CasinoPacino:ForcePokerCards()
@@ -283,7 +278,6 @@ function CasinoPacino:ForceRouletteWheel()
 	local roulette_master_table   = rmt_obj:GetValue()
 	local roulette_outcomes_table = rmt_obj:GetOffset(1)
 	local roulette_ball_table     = SGSL:Get(SGSL.data.roulette_ball_table_offset):GetValue()
-
 	for table_iter = 0, 6, 1 do
 		locals.set_int(
 			"casinoroulette",

SSV2/includes/features/online/yim_resupplier/YimResupplierV3.lua

@@ -885,25 +885,25 @@ function YRV3:CooldownHandler()
 	end
 end
 
-local fadedOutTimer = Timer.new(1e4)
-fadedOutTimer:Pause()
+---@return boolean isRunning, string? scriptName, string displayName
+function YRV3:FindRunningSaleScript()
+	for sn in pairs(self.m_raw_data.SellScripts) do
+		if (script.is_active(sn)) then
+			return true, sn, ScriptDisplayNames[sn] or "None"
+		end
+	end
+
+	return false, nil, "None"
+end
+
 function YRV3:SetupAutosell()
 	if (Time.Millis() - self.m_last_autosell_check_time < 1200) then
 		return
 	end
 
-	for sn in pairs(self.m_raw_data.SellScripts) do
-		if script.is_active(sn) then
-			self.m_sell_script_name = sn
-			self.m_sell_script_running = true
-			self.m_sell_script_disp_name = self:GetRunningSellScriptDisplayName()
-			break
-		else
-			self.m_sell_script_name = "None"
-			self.m_sell_script_disp_name = "None"
-			self.m_sell_script_running = false
-		end
-	end
+	self.m_sell_script_running,
+	self.m_sell_script_name,
+	self.m_sell_script_disp_name = self:FindRunningSaleScript()
 
 	if (self.m_sell_script_running and self.m_bhub_script_handle ~= 0) then -- was triggered from the mct
 		for _, scr in pairs(ScriptsToTerminate) do
@@ -916,9 +916,8 @@ function YRV3:SetupAutosell()
 		end
 
 		sleep(1000)
-
 		if (CAM.IS_SCREEN_FADING_OUT() or CAM.IS_SCREEN_FADED_OUT()) then
-			fadedOutTimer:Resume()
+			local fadedOutTimer = Timer.new(1e4)
 			while (not fadedOutTimer:IsDone()) do
 				if (not CAM.IS_SCREEN_FADED_OUT() or CAM.IS_SCREEN_FADING_IN()) then
 					break
@@ -932,9 +931,6 @@ function YRV3:SetupAutosell()
 				CAM.DO_SCREEN_FADE_IN(100)
 			end
 		end
-
-		fadedOutTimer:Reset()
-		fadedOutTimer:Pause()
 	end
 
 	self.m_last_autosell_check_time = Time.Millis()