Merge pull request #101 from How-Bout-No/feature/heists-menu

feat(YHV1): Add heists script

Author: xesdoog

SSV2/includes/features/YimHeistsV1.lua

@@ -0,0 +1,64 @@
+-- Copyright (C) 2026 SAMURAI (xesdoog) & Contributors.
+-- This file is part of Samurai's Scripts.
+--
+-- Permission is hereby granted to copy, modify, and redistribute
+-- this code as long as you respect these conditions:
+--	* Credit the owner and contributors.
+--	* Provide a copy of or a link to the original license (GPL-3.0 or later); see LICENSE.md or <https://www.gnu.org/licenses/>.
+
+
+---@class HeistInfo
+---@field name string
+---@field coords vec3|nil
+---@field blip integer BlipID
+---@field stat { name: string, val: integer}
+---@field optInfo? string
+
+---@alias HEIST_TYPES table<integer, HeistInfo>
+
+---@class YimHeists
+---@field private m_raw_data RawBusinessData
+---@field m_tab Tab
+local YimHeists = { m_raw_data = require("includes.data.yrv3_data") }
+YimHeists.__index = YimHeists
+
+---@return YimHeists
+function YimHeists:init()
+	local instance = setmetatable({
+		m_tab = GUI:RegisterNewTab(Enums.eTabID.TAB_ONLINE, "YimHeists")
+	}, self)
+
+	return instance
+end
+
+---@param statName string
+---@param statVal integer
+---@param notifTitle string
+function YimHeists:SkipPrep(statName, statVal, notifTitle)
+	stats.set_int(statName, statVal)
+	Notifier:ShowSuccess(notifTitle, _T("YH_PREP_SKIP_NOTIF"))
+end
+
+---@return vec3
+function YimHeists:GetAgencyLocation()
+	local property_index = stats.get_int("MPX_FIXER_HQ_OWNED")
+	if (not YRV3:IsPropertyIndexValid(property_index)) then
+		return
+	end
+
+	local ref = self.m_raw_data.Agencies[property_index]
+	return ref.coords
+end
+
+---@param where integer|vec3
+---@param keepVehicle? boolean
+function YimHeists:Teleport(where, keepVehicle)
+	if not Self:IsOutside() then
+		Notifier:ShowError("YHV1", "Please go outside first!")
+		return
+	end
+
+	Self:Teleport(where, keepVehicle)
+end
+
+return YimHeists

SSV2/includes/frontend/yhv1_ui.lua

@@ -0,0 +1,237 @@
+-- Copyright (C) 2026 SAMURAI (xesdoog) & Contributors.
+-- This file is part of Samurai's Scripts.
+--
+-- Permission is hereby granted to copy, modify, and redistribute
+-- this code as long as you respect these conditions:
+--	* Credit the owner and contributors.
+--	* Provide a copy of or a link to the original license (GPL-3.0 or later); see LICENSE.md or <https://www.gnu.org/licenses/>.
+
+
+local YHV1 = require("includes.features.YimHeistsV1"):init()
+
+---@type HEIST_TYPES
+local HEIST_TYPES = {
+	{
+		name = "Cluckin Bell",
+		coords = vec3:new(-1093.15, -807.14, 19.28),
+		blip = 871,
+		stat = {
+			name = "MPX_SALV23_INST_PROG",
+			val = 31,
+		}
+	},
+	{
+		name = "KnoWay",
+		coords = vec3:new(42.82, -1599.19, 29.60),
+		blip = 76,
+		stat = {
+			name = "MPX_M25_AVI_MISSION_CURRENT",
+			val = 4,
+		},
+	},
+	{
+		name = "Dr. Dre",
+		coords = YHV1:GetAgencyLocation(),
+		blip = 826,
+		stat = {
+			name = "MPX_FIXER_STORY_BS",
+			val = 4095,
+		}
+	},
+	{
+		name = "Oscar Guzman",
+		coords = vec3:new(2150.65, 4796.60, 41.17),
+		blip = 903,
+		stat = {
+			name = "MPX_HACKER24_INST_BS",
+			val = 31,
+		},
+		optInfo = "Complete first mission on Hard first!"
+	},
+}
+
+-- This is all a pretty asinine way of handling this and has some UI/UX inconsistencies but it's quick and it works good enuff for now
+-- TODO: Make this better
+local function drawBasicTab()
+	for i, heist in ipairs(HEIST_TYPES) do
+		ImGui.BeginDisabled(not heist.coords or not Game.IsValidCoords(heist.blip))
+		ImGui.PushID(i)
+		ImGui.BulletText(heist.name)
+
+		if (GUI:Button(_T("GENERIC_TELEPORT"))) then
+			YHV1:Teleport(heist.coords, false)
+		end
+
+		ImGui.SameLine()
+		if (GUI:Button(_T("GENERIC_SET_WAYPOINT"))) then
+			Game.SetWaypointCoords(heist.blip)
+		end
+
+		ImGui.SameLine()
+
+		ImGui.BeginDisabled(stats.get_int(heist.stat.name) == heist.stat.val)
+		if GUI:Button(_T("SY_COMPLETE_PREPARATIONS")) then
+			YHV1:SkipPrep(heist.stat.name, heist.stat.val, heist.name)
+		end
+		if (heist.optInfo) then
+			GUI:Tooltip(heist.optInfo)
+		end
+		ImGui.EndDisabled()
+		ImGui.PopID()
+		ImGui.EndDisabled()
+	end
+end
+
+local cayo_secondary_target_i = 2
+local cayo_secondary_target_c = 3
+
+local function drawCayoTab()
+	-- https://www.unknowncheats.me/forum/grand-theft-auto-v/695454-edit-cayo-perico-primary-target-stat-yimmenu-v2.html
+	-- https://www.unknowncheats.me/forum/grand-theft-auto-v/431801-cayo-perico-heist-click.html
+	local cayo_heist_primary    = stats.get_int("MPX_H4CNF_TARGET")
+	local cayo_heist_difficulty = stats.get_int("MPX_H4_PROGRESS")
+	local cayo_heist_weapons    = stats.get_int("MPX_H4CNF_WEAPONS")
+
+	ImGui.SeparatorText("Targets")
+
+	local new_primary_target, primary_target_clicked = ImGui.Combo(
+		_T "YH_CAYO_TARGET_PRIMARY",
+		cayo_heist_primary,
+		{ "Tequila", "Ruby", "Bearer Bonds", "Pink Diamond", "Madrazo Files", "Panther Statue" },
+		6
+	)
+
+	if (primary_target_clicked) then
+		stats.set_int("MPX_H4CNF_TARGET", new_primary_target)
+	end
+
+	ImGui.Spacing()
+
+	local secondary_targets = { "Cash", "Weed", "Coke", "Gold" }
+	local new_secondary_target_i, secondary_target_i_click = ImGui.Combo(
+		_T "YH_CAYO_TARGET_SECONDARY_I",
+		cayo_secondary_target_i,
+		secondary_targets,
+		4
+	)
+
+	if (secondary_target_i_click) then
+		cayo_secondary_target_i = new_secondary_target_i
+	end
+
+	local new_secondary_target_c, secondary_target_c_click = ImGui.Combo(
+		_T "YH_CAYO_TARGET_SECONDARY_C",
+		cayo_secondary_target_c,
+		secondary_targets,
+		4
+	)
+
+	if (secondary_target_c_click) then
+		cayo_secondary_target_c = new_secondary_target_c
+	end
+
+	-- https://www.unknowncheats.me/forum/4489469-post16.html
+	if GUI:Button("Set All Secondary Targets") then
+		local targets_i = { 0, 0, 0, 0 }
+		local targets_c = { 0, 0, 0, 0 }
+		targets_i[new_secondary_target_i + 1] = -1
+		targets_c[new_secondary_target_c + 1] = -1
+
+		stats.set_int("MPX_H4LOOT_CASH_I", targets_i[0])
+		stats.set_int("MPX_H4LOOT_CASH_I_SCOPED", targets_i[0])
+		stats.set_int("MPX_H4LOOT_WEED_I", targets_i[1])
+		stats.set_int("MPX_H4LOOT_WEED_I_SCOPED", targets_i[1])
+		stats.set_int("MPX_H4LOOT_COKE_I", targets_i[2])
+		stats.set_int("MPX_H4LOOT_COKE_I_SCOPED", targets_i[2])
+		stats.set_int("MPX_H4LOOT_GOLD_I", targets_i[3])
+		stats.set_int("MPX_H4LOOT_GOLD_I_SCOPED", targets_i[3])
+		stats.set_int("MPX_H4LOOT_CASH_C", targets_c[0])
+		stats.set_int("MPX_H4LOOT_WEED_C", targets_c[1])
+		stats.set_int("MPX_H4LOOT_COKE_C", targets_c[2])
+		stats.set_int("MPX_H4LOOT_GOLD_C", targets_c[3])
+		stats.set_int("MPX_H4LOOT_PAINT", -1) -- Not really any reason to have an option for paintings
+		stats.set_int("MPX_H4LOOT_PAINT_SCOPED", -1)
+	end
+
+	ImGui.SeparatorText(_T "GENERIC_SETTINGS_LABEL")
+
+	local new_difficulty, difficulty_toggled = GUI:CustomToggle(_T("YH_CAYO_DIFFICULTY"),
+		cayo_heist_difficulty > 130000
+	)
+
+	if (difficulty_toggled) then
+		if (new_difficulty) then
+			stats.set_int("MPX_H4_PROGRESS", 131055)
+		else
+			stats.set_int("MPX_H4_PROGRESS", 126823)
+		end
+	end
+
+	local new_weapons, weapons_clicked = ImGui.Combo(
+		_T "YH_CAYO_WEAPONS",
+		cayo_heist_weapons,
+		{ "Unselected", "Aggressor", "Conspirator", "Crackshot", "Saboteur", "Marksman" },
+		6
+	)
+
+	if (weapons_clicked) then
+		stats.set_int("MPX_H4CNF_WEAPONS", new_weapons)
+	end
+
+	-- https://www.unknowncheats.me/forum/3058973-post602.html
+	if GUI:Button(_T "CP_HEIST_UNLOCK_ALL") then
+		stats.set_int("MPX_H4CNF_BS_GEN", 131071)
+		stats.set_int("MPX_H4CNF_BS_ENTR", 63)
+		stats.set_int("MPX_H4CNF_BS_ABIL", 63)
+		stats.set_int("MPX_H4CNF_WEP_DISRP", 3)
+		stats.set_int("MPX_H4CNF_ARM_DISRP", 3)
+		stats.set_int("MPX_H4CNF_HEL_DISRP", 3)
+		stats.set_int("MPX_H4_MISSIONS", 65535)
+		if (stats.get_int("MPX_H4_PLAYTHROUGH_STATUS") == 0) then
+			stats.set_int("MPX_H4_PLAYTHROUGH_STATUS", 40000)
+		end
+		Notifier:ShowSuccess("YHV1", "Heist ready")
+	end
+
+	if GUI:Button(_T "YH_CAYO_RESET_ALL") then
+		stats.set_int("MPX_H4_MISSIONS", 0)
+		stats.set_int("MPX_H4_PROGRESS", 0)
+		stats.set_int("MPX_H4_PLAYTHROUGH_STATUS", 0)
+		stats.set_int("MPX_H4CNF_APPROACH", 0)
+		stats.set_int("MPX_H4CNF_BS_ENTR", 0)
+		stats.set_int("MPX_H4CNF_BS_GEN", 0)
+		stats.set_int("MPX_H4CNF_BS_ABIL", 0)
+		Notifier:ShowSuccess("YHV1", "All progress has been reset!")
+	end
+end
+
+local function HeistUI()
+	if (not Game.IsOnline() or not Backend:IsUpToDate()) then
+		ImGui.Text(_T("GENERIC_UNAVAILABLE_SP"))
+		return
+	end
+
+	if (ImGui.BeginTabBar("##dunkBar")) then
+		ImGui.PushStyleVar(ImGuiStyleVar.ItemSpacing, 10, 10)
+
+		if ImGui.BeginTabItem(_T("GENERIC_GENERAL_LABEL")) then
+			drawBasicTab()
+			ImGui.EndTabItem()
+		end
+
+		if ImGui.BeginTabItem(_T("YH_CAYO_TAB")) then
+			drawCayoTab()
+			ImGui.EndTabItem()
+		end
+
+		-- if ImGui.BeginTabItem(_T("YH_DDAY_TAB")) then
+		-- 	drawDDayTab()
+		-- 	ImGui.EndTabItem()
+		-- end
+
+		ImGui.PopStyleVar()
+		ImGui.EndTabBar()
+	end
+end
+
+YHV1.m_tab:RegisterGUI(HeistUI)

SSV2/includes/init.lua

@@ -124,6 +124,7 @@ local packages      = {
 	"frontend.vehicle.vehicle_ui",
 	"frontend.world_ui",
 	"frontend.yav3_ui",
+	"frontend.yhv1_ui",
 	"frontend.yrv3_ui",
 }
 

SSV2/includes/lib/translations/__hashmap.json

@@ -626,5 +626,16 @@
     "SELF_ABILITY_MENTAL_STATE": 2176330063,
     "YRV3_CEO_OFFICE_NOT_OWNED": 1352588371,
     "YRV3_WAREHOUSE_SLOT": 1803512971,
-    "YRV3_CARGO_WAREHOUSES_LABEL": 2490296227
+    "YRV3_CARGO_WAREHOUSES_LABEL": 2490296227,
+    "YH_BASIC_TAB": 4281242592,
+    "YH_CAYO_TAB": 3700029630,
+    "YH_PREP_SKIP": 2659644214,
+    "YH_PREP_SKIP_NOTIF": 316236424,
+    "YH_CAYO_TARGET_PRIMARY": 359769569,
+    "YH_CAYO_TARGET_SECONDARY_I": 752009453,
+    "YH_CAYO_TARGET_SECONDARY_C": 2356233384,
+    "YH_CAYO_TARGET_SECONDARY_BUTTON": 1840450233,
+    "YH_CAYO_DIFFICULTY": 950376902,
+    "YH_CAYO_WEAPONS": 4293173989,
+    "YH_CAYO_RESET_ALL": 3192949709
 }

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

@@ -626,5 +626,16 @@ return {
 	["SELF_ABILITY_FLYING"] = "Fliegen",
 	["YRV3_WAREHOUSE_SLOT"] = "Lager %d",
 	["YRV3_CEO_OFFICE_NOT_OWNED"] = "Sie besitzen kein CEO-Büro.",
-	["YRV3_CARGO_WAREHOUSES_LABEL"] = "Spezielle Frachtlager"
+	["YRV3_CARGO_WAREHOUSES_LABEL"] = "Spezielle Frachtlager",
+	["YH_BASIC_TAB"] = "Basic",
+	["YH_CAYO_TAB"] = "Cayo Perico",
+	["YH_PREP_SKIP_NOTIF"] = "Alle Vorbereitungsmissionen wurden übersprungen. Sie können nun mit der letzten Mission beginnen.",
+	["YH_CAYO_TARGET_SECONDARY_I"] = "Sekundäres Ziel (Insel)",
+	["YH_CAYO_TARGET_SECONDARY_C"] = "Sekundäres Ziel (Verbindung)",
+	["YH_CAYO_TARGET_SECONDARY_BUTTON"] = "Legen Sie alle sekundären Ziele fest",
+	["YH_CAYO_RESET_ALL"] = "Setzen Sie ALLE Fortschritte zurück",
+	["YH_CAYO_TARGET_PRIMARY"] = "Primäres Ziel",
+	["YH_CAYO_DIFFICULTY"] = "Harter Modus",
+	["YH_PREP_SKIP"] = "Überspringen Sie Vorbereitungsmissionen",
+	["YH_CAYO_WEAPONS"] = "Waffenausstattung"
 }

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

@@ -687,4 +687,17 @@ return {
 	["EF_IMPORT_SUCCESS"]                  = "Data successfully imported.",
 	["EF_CHILD_ALPHA"]                     = "Child Item Transparency: %d",
 	--#endregion
+
+	--#region YimHeists
+	["YH_BASIC_TAB"]                       = "Basic",
+	["YH_CAYO_TAB"]                        = "Cayo Perico",
+	["YH_PREP_SKIP_NOTIF"]                 = "All preparation missions have been skipped. You can now start the final mission.",
+	["YH_CAYO_TARGET_PRIMARY"]             = "Primary Target",
+	["YH_CAYO_TARGET_SECONDARY_I"]         = "Secondary Target (Island)",
+	["YH_CAYO_TARGET_SECONDARY_C"]         = "Secondary Target (Compound)",
+	["YH_CAYO_TARGET_SECONDARY_BUTTON"]    = "Set All Secondary Targets",
+	["YH_CAYO_DIFFICULTY"]                 = "Hard Mode",
+	["YH_CAYO_WEAPONS"]                    = "Weapon Loadout",
+	["YH_CAYO_RESET_ALL"]                  = "Reset ALL Progress",
+	--#endregion
 }

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

@@ -626,5 +626,16 @@ return {
 	["SELF_ABILITY_LUNG_CAPACITY"] = "Capacidad pulmonar",
 	["YRV3_CEO_OFFICE_NOT_OWNED"] = "No eres dueño de una oficina de director ejecutivo.",
 	["YRV3_WAREHOUSE_SLOT"] = "Almacén %d",
-	["YRV3_CARGO_WAREHOUSES_LABEL"] = "Bodegas de Carga Especial"
+	["YRV3_CARGO_WAREHOUSES_LABEL"] = "Bodegas de Carga Especial",
+	["YH_BASIC_TAB"] = "Básico",
+	["YH_CAYO_TAB"] = "Cayo Perico",
+	["YH_PREP_SKIP"] = "Saltar misiones de preparación",
+	["YH_CAYO_TARGET_PRIMARY"] = "Objetivo principal",
+	["YH_CAYO_DIFFICULTY"] = "Modo difícil",
+	["YH_CAYO_TARGET_SECONDARY_C"] = "Objetivo secundario (compuesto)",
+	["YH_PREP_SKIP_NOTIF"] = "Se han omitido todas las misiones de preparación. Ahora puedes comenzar la misión final.",
+	["YH_CAYO_TARGET_SECONDARY_I"] = "Objetivo secundario (isla)",
+	["YH_CAYO_WEAPONS"] = "Equipamiento de armas",
+	["YH_CAYO_RESET_ALL"] = "Restablecer TODO el progreso",
+	["YH_CAYO_TARGET_SECONDARY_BUTTON"] = "Establecer todos los objetivos secundarios"
 }