refactor(YimActions): refactor history

- Change play history into a self-contained struct rather than a raw table.
- Add navigable tips in the main YimActions UI.

Author: xesdoog

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/features/YimActionsV3.lua

@@ -12,6 +12,7 @@ local CompanionManager   = require("includes.services.CompanionManager")
 local t_AnimList         = require("includes.data.actions.animations")
 local t_PedScenarios     = require("includes.data.actions.scenarios")
 local Action             = require("includes.structs.Action")
+local ActionsHistory     = require("includes.structs.ActionsHistory")
 local Weapons            = require("includes.data.weapons")
 local COL_YELLOW <const> = Color("yellow")
 
@@ -21,11 +22,6 @@ local COL_YELLOW <const> = Color("yellow")
 --- | "scenes"
 --- | "clipsets"
 
----@alias ActionHistorySortMode
----| 0 Timestamp
----| 1 Type
----| 2 Label
-
 ---@class YimActionsFavorites
 ---@field anims table<string, AnimData>
 ---@field scenarios table<string, ScenarioData>
@@ -45,8 +41,7 @@ local COL_YELLOW <const> = Color("yellow")
 ---@field public Commands table<string, ActionCommandData>
 ---@field public DrawNewCommandWindow boolean
 ---@field public CurrentlyPlaying table<handle, Action>
----@field public LastPlayed { count: integer, sort_mode: ActionHistorySortMode, data: array<{ action: Action, timestamp: seconds, type: eActionType, fmt: string }> }
----@field private m_history_lookup set<string>
+---@field public LastPlayed ActionsHistory
 ---@field public CompanionManager CompanionManager
 local YimActions   = {}
 YimActions.__index = YimActions
@@ -60,13 +55,8 @@ function YimActions:init()
 	self.DrawNewCommandWindow = false
 	self.CompanionManager     = CompanionManager.new()
 	self.SceneManager         = SceneManager.new()
+	self.LastPlayed           = ActionsHistory.new()
 	self.CurrentlyPlaying     = {}
-	self.m_history_lookup     = {}
-	self.LastPlayed           = {
-		data      = {},
-		count     = 0,
-		sort_mode = 0,
-	}
 	self.Commands             = {}
 	self.m_file_names         = {
 		favorites = "saved_actions.json",
@@ -103,81 +93,21 @@ end
 function YimActions:UpdatePlayHistory(ped)
 	local current = self.CurrentlyPlaying[self:GetPed(ped)]
 	if (not current) then return end
-
-	local label = current.data.label
-	local lookupArray = self.m_history_lookup
-	if (lookupArray[label]) then return end
-
-	local type  = current.action_type
-	local fmt   = _F("[%s]  %s", current:TypeAsString(), label)
-	local epoch = DateTime:Now():Epoch()
-	table.insert(self.LastPlayed.data, {
-		action    = current,
-		timestamp = epoch,
-		type      = type,
-		fmt       = fmt,
-	})
-
-	lookupArray[label]    = true
-	self.LastPlayed.count = #self.LastPlayed.data
-	self:SortPlayHistory()
+	self.LastPlayed:Push(current)
 end
 
 ---@param index integer
 function YimActions:RemoveFromHistory(index)
-	local data  = self.LastPlayed.data
-	local count = #data
-	if (count == 0) then return end
-
-	if (count == 1) then
-		self.LastPlayed.data  = {}
-		self.m_history_lookup = {}
-		self.LastPlayed.count = 0
-		return
-	end
-
-	---@type { action: Action, timestamp: seconds, type: eActionType, fmt: string }?
-	local entry = table.remove(data, index)
-	if (entry) then
-		self.m_history_lookup[entry.action.data.label] = nil
-	end
-	self.LastPlayed.count = math.max(0, count - 1)
+	self.LastPlayed:Pop(index)
 end
 
 function YimActions:ClearPlayHistory()
-	local count = self.LastPlayed.count
-	if (count == 0) then
-		return
-	end
-
-	local lastPlayed = self.LastPlayed.data
-	ThreadManager:Run(function()
-		for i = count, 1, -1 do
-			table.remove(lastPlayed, i)
-			yield(5)
-		end
-		self.LastPlayed.count = 0
-		self.m_history_lookup = {}
-	end)
+	self.LastPlayed:Clear()
 end
 
 ---@param mode ActionHistorySortMode?
 function YimActions:SortPlayHistory(mode)
-	if (mode and mode == self.LastPlayed.sort_mode) then
-		return
-	end
-
-	mode = mode or self.LastPlayed.sort_mode
-	table.sort(self.LastPlayed.data, function(a, b)
-		if (mode == 0) then
-			return a.timestamp > b.timestamp
-		elseif (mode == 1) then
-			return a.type < b.type
-		end
-
-		return a.action.data.label < b.action.data.label
-	end)
-	self.LastPlayed.sort_mode = mode
+	self.LastPlayed:Sort(mode)
 end
 
 ---@return boolean

SSV2/includes/frontend/yim_actions/actions_ui.lua

@@ -9,8 +9,9 @@
 
 ---@type Action?
 local selectedAction
-local sharedDrawFuncs     = require("includes.frontend.yim_actions.shared_draw_funcs")
-local selectedSidebarItem = 1
+local sharedDrawFuncs  = require("includes.frontend.yim_actions.shared_draw_funcs")
+local sidebarItemIndex = 1
+local sidebarTipIndex  = 1
 
 
 local t_ActionsSidebarItems <const> = {
@@ -36,10 +37,16 @@ local t_ActionsSidebarItems <const> = {
 	},
 }
 
+local SideBarTips <const> = {
+	function() return _F(_T("YAV3_STOP_BTN_HINT"), GVars.keyboard_keybinds.stop_anim) end,
+	function() return _F(_T("YAV3_SYMBOL_DEFS_HINT"), "[*]", "[C]", "[U]") end,
+	function() return _T("YAV3_LIST_VIEW_HINT") end,
+}
+
 local function DrawSidebarItems()
-	local selectedTab = t_ActionsSidebarItems[selectedSidebarItem]
+	local selectedTab = t_ActionsSidebarItems[sidebarItemIndex]
 	if (selectedTab and selectedTab.callback) then
-		selectedAction = selectedTab.callback()
+		selectedAction = selectedTab.callback(selectedTab.label)
 	end
 end
 
@@ -51,32 +58,52 @@ local function DrawActionsSidebar()
 	ImGui.Dummy(1, 100)
 
 	for i, tab in ipairs(t_ActionsSidebarItems) do
-		local is_selected = (selectedSidebarItem == i)
+		local is_selected = (sidebarItemIndex == i)
 		if (is_selected) then
 			local r, g, b, a = ImGui.GetStyleColorVec4(ImGuiCol.ButtonActive)
 			ImGui.PushStyleColor(ImGuiCol.Button, r, g, b, a)
 		end
 
 		if (ImGui.Button(tab.label, is_selected and 150 or 128, 35)) then
 			GUI:PlaySound("Nav")
-			if (selectedSidebarItem ~= i) then
+			if (sidebarItemIndex ~= i) then
 				selectedAction = nil
 			end
-			selectedSidebarItem = i
+			sidebarItemIndex = i
 		end
 
 		if (is_selected) then
 			ImGui.PopStyleColor()
 		end
 	end
-
 	ImGui.PopStyleVar(2)
-	ImGui.SetWindowFontScale(0.75)
-	local region        = vec2:new(ImGui.GetContentRegionAvail())
-	local s_SidebarTip  = _F(_T("YAV3_STOP_BTN_HINT"), GVars.keyboard_keybinds.stop_anim)
+
+	local region       = vec2:new(ImGui.GetContentRegionAvail())
+	local s_SidebarTip = SideBarTips[sidebarTipIndex]()
+	ImGui.SetWindowFontScale(0.70)
 	local _, textHeight = ImGui.CalcTextSize(s_SidebarTip, false, region.x)
-	ImGui.SetCursorPos(0.0, ImGui.GetCursorPosY() + region.y - textHeight - 10)
+	ImGui.SetCursorPos(0.0, ImGui.GetCursorPosY() + region.y - textHeight - 25)
 	ImGui.TextWrapped(s_SidebarTip)
+	if (ImGui.SmallButton("  <  ")) then
+		GUI:PlaySound(GUI.Sounds.Nav)
+		if (sidebarTipIndex == 1) then
+			sidebarTipIndex = #SideBarTips
+			return
+		end
+		sidebarTipIndex = sidebarTipIndex - 1
+	end
+	GUI:Tooltip(_T("GENERIC_PREVIOUS"))
+
+	ImGui.SameLine()
+	if (ImGui.SmallButton("  >  ")) then
+		GUI:PlaySound(GUI.Sounds.Nav)
+		if (sidebarTipIndex == #SideBarTips) then
+			sidebarTipIndex = 1
+			return
+		end
+		sidebarTipIndex = sidebarTipIndex + 1
+	end
+	GUI:Tooltip(_T("GENERIC_NEXT"))
 	ImGui.SetWindowFontScale(1.0)
 	ImGui.EndChild()
 end

SSV2/includes/frontend/yim_actions/companions_ui.lua

@@ -218,13 +218,13 @@ return function()
 	ImGui.BeginTabBar("##companion_actions_tabbar")
 	if (ImGui.BeginTabItem("Animations##companions")) then
 		currentTabName = "companion_anims"
-		selectedAction = sharedDrawFuncs.DrawAnims()
+		selectedAction = sharedDrawFuncs.DrawAnims(currentTabName)
 		ImGui.EndTabItem()
 	end
 
 	if (ImGui.BeginTabItem("Scenarios##companions")) then
 		currentTabName = "companion_scenarios"
-		selectedAction = sharedDrawFuncs.DrawScenarios()
+		selectedAction = sharedDrawFuncs.DrawScenarios(currentTabName)
 		ImGui.EndTabItem()
 	end
 

SSV2/includes/frontend/yim_actions/movement_clipsets_ui.lua

@@ -74,7 +74,7 @@ local function DrawJsonMovementClipsets()
 		end
 
 		ImGui.BeginDisabled(not jsonClipsetListCreated)
-		local __t = ClipsetBrowser:SwitchMode("other", jsonArray):Draw()
+		local __t = ClipsetBrowser:SwitchMode({ mode_name = "other", new_data = jsonArray }):Draw()
 		ImGui.EndDisabled()
 
 		selectedClipset = __t and __t.data or nil
@@ -88,7 +88,7 @@ local function DrawFavoriteMovementClipsets()
 		return
 	end
 
-	local __t = ClipsetBrowser:SwitchMode("favorites", favorites):Draw()
+	local __t = ClipsetBrowser:SwitchMode({ mode_name = "favorites", new_data = favorites }):Draw()
 	selectedClipset = __t and __t.data or nil
 end
 

SSV2/includes/frontend/yim_actions/shared_draw_funcs.lua

@@ -46,7 +46,7 @@ local function ListFavoritesByCategory(category)
 		return
 	end
 
-	selectedAction = browser:SwitchMode("favorites", cat):Draw()
+	selectedAction = browser:SwitchMode({ mode_name = "favorites", new_data = cat, str_id = "favorites" }):Draw()
 end
 
 local function DrawFavorites()
@@ -86,31 +86,31 @@ local function DrawFavorites()
 end
 
 local function DrawHistory()
-	local count = YimActions.LastPlayed.count
+	local actionHistory = YimActions.LastPlayed
+	local count         = actionHistory:GetCount()
 	if (count == 0) then
 		ImGui.TextWrapped("Animations, scenarios, and scenes you play will appear here.")
 		return
 	end
 
+	ImGui.BeginDisabled(actionHistory:IsLocked())
 	if (GUI:Button(_T("GENERIC_CLEAR"))) then
-		YimActions:ClearPlayHistory()
+		actionHistory:Clear()
 	end
 	ImGui.Separator()
 
 	if (count > 1) then
-		local sort_mode, clicked = ImGui.Combo(_T("GENERIC_LIST_SORT"), YimActions.LastPlayed.sort_mode, "Time\0Type\0Label\0")
-		if (clicked) then
-			YimActions:SortPlayHistory(sort_mode)
-		end
+		local sort_mode, clicked = ImGui.Combo(_T("GENERIC_LIST_SORT"), actionHistory:GetSortMode(), "Time\0Type\0Label\0")
+		if (clicked) then actionHistory:Sort(sort_mode) end
 	end
 
 	if (ImGui.BeginListBox("##playHistory", -1, -1)) then
 		local button_width      = 30
 		local selectable_width  = ImGui.GetContentRegionAvail() - 80
 		local selectable_height = ImGui.GetTextLineHeight()
-		local to_eemove         = nil
+		local to_remove         = nil
 
-		for i, entry in ipairs(YimActions.LastPlayed.data) do
+		for i, entry in actionHistory:Iter() do
 			ImGui.SetWindowFontScale(0.8)
 			ImGui.TextDisabled(DateTime(entry.timestamp):Format("%H:%M"))
 			ImGui.SetWindowFontScale(1.0)
@@ -122,37 +122,42 @@ local function DrawHistory()
 				selectedAction = action
 			end
 
-			local rectMin = vec2:new(ImGui.GetItemRectMin())
-			local rectMax = vec2:new(ImGui.GetItemRectMax())
-			local hovered = ImGui.IsMouseHoveringRect(rectMin.x, rectMin.y, rectMax.x + button_width, rectMax.y)
-			if (hovered) then
+			local rect_min   = vec2:new(ImGui.GetItemRectMin())
+			local rect_max   = vec2:new(ImGui.GetItemRectMax())
+			local is_hovered = ImGui.IsMouseHoveringRect(rect_min.x, rect_min.y, rect_max.x + button_width, rect_max.y)
+			if (is_hovered) then
 				ImGui.SameLine()
 				if (ImGui.SmallButton(" x ")) then
-					to_eemove = i
+					to_remove = i
 				end
 				GUI:Tooltip(_T("GENERIC_DELETE"))
 			end
 		end
 
-		if (to_eemove) then
-			YimActions:RemoveFromHistory(to_eemove)
+		if (to_remove) then
+			actionHistory:Pop(to_remove)
+			to_remove = nil
 		end
 		ImGui.EndListBox()
 	end
+	ImGui.EndDisabled()
 
 	return selectedAction
 end
 
-local function DrawAnims()
-	return Browsers.anims:ResetMode():Draw()
+---@param tabName string
+local function DrawAnims(tabName)
+	return Browsers.anims:ResetMode(tabName):Draw()
 end
 
-local function DrawScenarios()
-	return Browsers.scenarios:ResetMode():Draw()
+---@param tabName string
+local function DrawScenarios(tabName)
+	return Browsers.scenarios:ResetMode(tabName):Draw()
 end
 
-local function DrawScenes()
-	return Browsers.scenes:ResetMode():Draw()
+---@param tabName string
+local function DrawScenes(tabName)
+	return Browsers.scenes:ResetMode(tabName):Draw()
 end
 
 return {

SSV2/includes/lib/translations/__hashmap.json

@@ -855,5 +855,7 @@
     "GENERIC_ENABLE": 2433038897,
     "GENERIC_DISABLE": 566765743,
     "VEH_STANCE_UPDATE_WARN": 247724004,
-    "ASSET_BROWSER_CONTEXT_TT": 1745203944
+    "ASSET_BROWSER_CONTEXT_TT": 1745203944,
+    "YAV3_SYMBOL_DEFS_HINT": 4201697999,
+    "YAV3_LIST_VIEW_HINT": 3504302049
 }

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

@@ -855,5 +855,7 @@ return {
 	["GENERIC_DISABLE"] = "Deaktivieren",
 	["GENERIC_ENABLE"] = "Aktivieren",
 	["VEH_STANCE_UPDATE_WARN"] = "Sind Sie sicher, dass Sie die gespeicherte Haltung für %s überschreiben möchten?",
-	["ASSET_BROWSER_CONTEXT_TT"] = "Klicken Sie mit der rechten Maustaste, um das Kontextmenü zu öffnen."
+	["ASSET_BROWSER_CONTEXT_TT"] = "Klicken Sie mit der rechten Maustaste, um das Kontextmenü zu öffnen.",
+	["YAV3_LIST_VIEW_HINT"] = "Die Animations- und Szenariolistenansichten sind auf den Registerkarten „Aktionen“ und „Gefährten“ genau gleich, was bedeutet, dass alle Filter, die Sie auf einer Registerkarte verwenden, auch auf der anderen vorhanden sind. Dies gilt jedoch nicht für die Registerkarten „Verlauf“ und „Favoriten“.",
+	["YAV3_SYMBOL_DEFS_HINT"] = "Haben Sie sich jemals gefragt, was die seltsamen Symbole für einige Aktionen in der Liste sind?\n\n- %s: Als Favorit gespeichert.\n- %s: Als Befehl registriert.\n- %s: Vom Benutzer generiert."
 }