refactor(YHV1): Rebrand to Mastermind

Author: How-Bout-No

SSV2/includes/features/YimHeistsV1.lua SSV2/includes/features/Mastermind.luaSSV2/includes/features/YimHeistsV1.lua renamed to SSV2/includes/features/Mastermind.lua

@@ -34,16 +34,16 @@ local secondary_targets = { "CASH", "WEED", "COKE", "GOLD" }
 
 ---@alias HEIST_TYPES table<integer, HeistInfo>
 
----@class YimHeists
+---@class Mastermind
 ---@field private m_raw_data RawBusinessData
 ---@field private m_properties { agency: AgencyProperty, hangar: FieldHangarProperty, facility: FacilityProperty, submarine: SubmarineProperty }
 ---@field m_tab Tab
-local YimHeists         = { m_raw_data = require("includes.data.yrv3_data") }
-YimHeists.__index       = YimHeists
-YimHeists.__label       = "YimHeists"
+local Mastermind        = { m_raw_data = require("includes.data.yrv3_data") }
+Mastermind.__index      = Mastermind
+Mastermind.__label      = "Mastermind"
 
----@return YimHeists
-function YimHeists:init()
+---@return Mastermind
+function Mastermind:init()
 	local instance = setmetatable({
 		m_properties = {}
 	}, self)
@@ -62,38 +62,38 @@ end
 ---@param statName string
 ---@param statVal integer
 ---@param notifTitle string
-function YimHeists:SkipPrep(statName, statVal, notifTitle)
+function Mastermind:SkipPrep(statName, statVal, notifTitle)
 	stats.set_int(statName, statVal)
 	Notifier:ShowSuccess(notifTitle, _T("YH_PREP_SKIP_NOTIF"))
 end
 
 -- https://www.unknowncheats.me/forum/4489469-post16.html
 ---@param type string
 ---@param index integer
-function YimHeists:SetSecondaryTargets(type, index)
+function Mastermind:SetCayoSecTargets(type, index)
 	local targets = { 0, 0, 0, 0 }
 	targets[index] = -1
 
 	for st = 1, 4 do
 		local stat_name = _F("MPX_H4LOOT_%s_%s", secondary_targets[st], type)
 		stats.set_int(stat_name, targets[st])
-		stats.set_int(stat_name .. "_SCOPED", targets[st])
+		stats.set_int(_F("%s_SCOPED", stat_name), targets[st])
 	end
 
 	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
 
 ---@return integer, integer
-function YimHeists:GetSecondaryTargets()
+function Mastermind:GetCayoSecTargets()
 	local loot_i, loot_c
 
 	for st = 1, 4 do
 		local stat_name = _F("MPX_H4LOOT_%s", secondary_targets[st])
-		if (stats.get_int(stat_name .. "_I") == -1) then
+		if (stats.get_int(_F("%s_I", stat_name)) == -1) then
 			loot_i = st - 1 -- ImGui indexes by 0
 		end
-		if (stats.get_int(stat_name .. "_C") == -1) then
+		if (stats.get_int(_F("%s_C", stat_name)) == -1) then
 			loot_c = st - 1
 		end
 	end
@@ -114,7 +114,7 @@ local function GetSubCoordsGlobal()
 		:At(vec_offset)
 end
 
-function YimHeists:ReadPropertyData()
+function Mastermind:ReadPropertyData()
 	ThreadManager:Run(function()
 		while (Game.IsInTransition()) do
 			yield()
@@ -165,7 +165,7 @@ function YimHeists:ReadPropertyData()
 end
 
 ---@return vec3
-function YimHeists:GetAviLocation()
+function Mastermind:GetAviLocation()
 	local stat = stats.get_int("MPX_M25_AVI_MISSION_CURRENT")
 	local blip = HUD.GET_FIRST_BLIP_INFO_ID(76)
 	if (blip and stat ~= 4) then
@@ -179,12 +179,12 @@ function YimHeists:GetAviLocation()
 end
 
 ---@return AgencyProperty?
-function YimHeists:GetAgencyProperty()
+function Mastermind:GetAgencyProperty()
 	return self.m_properties.agency
 end
 
 ---@return vec3?
-function YimHeists:GetAgencyLocation()
+function Mastermind:GetAgencyLocation()
 	local agency = self:GetAgencyProperty()
 	if (not agency) then
 		return
@@ -194,12 +194,12 @@ function YimHeists:GetAgencyLocation()
 end
 
 ---@return FieldHangarProperty?
-function YimHeists:GetFieldHangarProperty()
+function Mastermind:GetFieldHangarProperty()
 	return self.m_properties.hangar
 end
 
 ---@return vec3?
-function YimHeists:GetFieldHangarLocation()
+function Mastermind:GetFieldHangarLocation()
 	local hangar = self:GetFieldHangarProperty()
 	if (not hangar) then
 		return
@@ -209,12 +209,12 @@ function YimHeists:GetFieldHangarLocation()
 end
 
 ---@return FacilityProperty?
-function YimHeists:GetFacilityProperty()
+function Mastermind:GetFacilityProperty()
 	return self.m_properties.facility
 end
 
 ---@return vec3?
-function YimHeists:GetFacilityLocation()
+function Mastermind:GetFacilityLocation()
 	local facility = self:GetFacilityProperty()
 	if (not facility) then
 		return
@@ -224,7 +224,7 @@ function YimHeists:GetFacilityLocation()
 end
 
 ---@return SubmarineProperty?
-function YimHeists:GetSubmarine()
+function Mastermind:GetSubmarine()
 	local sub = self.m_properties.submarine
 	if (not sub) then
 		return
@@ -236,4 +236,4 @@ function YimHeists:GetSubmarine()
 	return sub
 end
 
-return YimHeists
+return Mastermind

SSV2/includes/frontend/yhv1_ui.lua SSV2/includes/frontend/mastermind_ui.luaSSV2/includes/frontend/yhv1_ui.lua renamed to SSV2/includes/frontend/mastermind_ui.lua

@@ -7,7 +7,7 @@
 --	* 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()
+local Mastermind         = require("SSV2.includes.features.Mastermind"):init()
 local SGSL               = require("includes.services.SGSL")
 local secondary_targets  = { "Cash", "Weed", "Coke", "Gold" }
 local cayo_secondary_target_i, cayo_secondary_target_c
@@ -26,10 +26,10 @@ local heistNames <const> = { -- https://github.com/root-cause/v-labels/blob/mast
 	BogdanProblem = "HPSTRAND_SUBb",
 	DoomsdayScenario = "HPSTRAND_MSILb",
 }
-local tabNames <const>   = {
-	"YH_BASIC_TAB", -- Basic
-	"ISLAND_TRAVEL_T", -- Cayo Perico
-	"FMMC_RSTAR_MHS2", -- The Doomsday Heist
+local tabNames <const>   = { --
+	"YH_BASIC_TAB",          -- Basic
+	"ISLAND_TRAVEL_T",       -- Cayo Perico
+	"FMMC_RSTAR_MHS2",       -- The Doomsday Heist
 }
 
 ---@type HEIST_TYPES
@@ -53,7 +53,7 @@ local HEIST_TYPES        = {
 			return heistNames.KnoWayOut
 		end,
 		get_coords = function()
-			return YHV1:GetAviLocation()
+			return Mastermind:GetAviLocation()
 		end,
 		stat = {
 			name = "MPX_M25_AVI_MISSION_CURRENT",
@@ -67,7 +67,7 @@ local HEIST_TYPES        = {
 			return heistNames.DontFuckWithDre
 		end,
 		get_coords = function()
-			return YHV1:GetAgencyLocation()
+			return Mastermind:GetAgencyLocation()
 		end,
 		stat = {
 			name = "MPX_FIXER_STORY_BS",
@@ -81,7 +81,7 @@ local HEIST_TYPES        = {
 			return heistNames.OscarGuzmanFliesAgain
 		end,
 		get_coords = function()
-			return YHV1:GetFieldHangarLocation()
+			return Mastermind:GetFieldHangarLocation()
 		end,
 		stat = {
 			name = "MPX_HACKER24_INST_BS",
@@ -119,7 +119,7 @@ local function drawBasicTab()
 		ImGui.BeginDisabled(is_done or on_cooldown)
 		ImGui.SameLine()
 		if GUI:Button(_T("SY_COMPLETE_PREPARATIONS")) then
-			YHV1:SkipPrep(heist.stat.name, heist.stat.val, heist_name)
+			Mastermind:SkipPrep(heist.stat.name, heist.stat.val, heist_name)
 		end
 		if (heist.opt_info and not is_done) then
 			GUI:Tooltip(heist.opt_info)
@@ -145,7 +145,7 @@ local function drawBasicTab()
 end
 
 local function drawCayoTab()
-	local sub = YHV1:GetSubmarine()
+	local sub = Mastermind:GetSubmarine()
 	if (not sub) then
 		ImGui.Text(_T("YH_SUBMARINE_NOT_OWNED"))
 		return
@@ -175,7 +175,7 @@ local function drawCayoTab()
 	if (GUI:Button(btn_label)) then
 		ThreadManager:Run(function()
 			if (not LocalPlayer:IsOutside()) then
-				Notifier:ShowError(YHV1.__label, _T("GENERIC_TP_INTERIOR_ERR"))
+				Notifier:ShowError(Mastermind.__label, _T("GENERIC_TP_INTERIOR_ERR"))
 				return
 			end
 
@@ -228,7 +228,7 @@ local function drawCayoTab()
 	)
 
 	if (secondary_target_click) then
-		YHV1:SetSecondaryTargets("I", cayo_secondary_target_i + 1)
+		Mastermind:SetCayoSecTargets("I", cayo_secondary_target_i + 1)
 	end
 
 	cayo_secondary_target_c, secondary_target_click = ImGui.Combo(
@@ -239,7 +239,7 @@ local function drawCayoTab()
 	)
 
 	if (secondary_target_click) then
-		YHV1:SetSecondaryTargets("C", cayo_secondary_target_c + 1)
+		Mastermind:SetCayoSecTargets("C", cayo_secondary_target_c + 1)
 	end
 
 	ImGui.Spacing()
@@ -306,14 +306,14 @@ local function drawCayoTab()
 			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.__label, "All Cayo progress has been reset!")
+			Notifier:ShowSuccess(Mastermind.__label, "All Cayo progress has been reset!")
 		end
 	end
 end
 
 -- Help text and values copied from: https://www.unknowncheats.me/forum/grand-theft-auto-v/431801-cayo-perico-heist-click.html
 local function drawDDayTab()
-	local facility = YHV1:GetFacilityProperty()
+	local facility = Mastermind:GetFacilityProperty()
 	if (not facility) then
 		ImGui.Text(_T("YH_FACILITY_NOT_OWNED"))
 		return
@@ -406,7 +406,7 @@ local function HeistUI()
 		return
 	end
 
-	cayo_secondary_target_i, cayo_secondary_target_c = YHV1:GetSecondaryTargets()
+	cayo_secondary_target_i, cayo_secondary_target_c = Mastermind:GetCayoSecTargets()
 
 	if (ImGui.BeginTabBar("##funkBar")) then
 		ImGui.PushStyleVar(ImGuiStyleVar.ItemSpacing, 10, 10)
@@ -424,7 +424,7 @@ local function HeistUI()
 	end
 end
 
-GUI:RegisterNewTab(Enums.eTabID.TAB_ONLINE, YHV1.__label, HeistUI)
+GUI:RegisterNewTab(Enums.eTabID.TAB_ONLINE, Mastermind.__label, HeistUI)
 
 ThreadManager:Run(function()
 	Translator:TranslateGXTList(tabNames)

SSV2/includes/init.lua

@@ -119,12 +119,12 @@ local packages      = {
 	"frontend.entity_forge_ui",
 	"frontend.bsv2_ui",
 	"frontend.casino_ui",
+	"frontend.mastermind_ui",
 	"frontend.self.self_ui",
 	"frontend.settings.settings_ui",
 	"frontend.vehicle.vehicle_ui",
 	"frontend.world_ui",
 	"frontend.yav3_ui",
-	"frontend.yhv1_ui",
 	"frontend.yrv3.yrv3_ui",
 }
 

docs/Features.md

@@ -26,7 +26,7 @@ SSV2 includes polished versions of your favorite features from previous versions
       <ul>
         <li><a href="#yimresupplierv3">YimResupplierV3</a></li>
         <li><a href="#casinopacino">CasinoPacino</a></li>
-        <li><a href="#yimheistsv1">YimHeistsV1</a></li>
+        <li><a href="#mastermind">Mastermind</a></li>
       </ul>
     </li>
     <li>
@@ -357,7 +357,7 @@ A business manager that supports auto-fill and auto-sell for several businesses,
 
 An updated and slightly refactored version of [Casino Pacino](https://github.com/YimMenu-Lua/Casino-Pacino).
 
-### YimHeistsV1
+### Mastermind
 
 A heist editor added by [@How-Bout-No](https://github.com/How-Bout-No) [WIP].