ME5_ConfigCheck.lua

-----------------------------------------------------------------
-----------------------------------------------------------------
-- MASS EFFECT: UNIFICATION Master Script by Aaron Gilbert
-- Build 31025/06
-- Screen Names: Marth8880, GT-Marth8880, [GT] Marth8880, [GT] Bran
-- E-Mail: Marth8880@gmail.com
-- Oct 25, 2016
-- Copyright (c) 2017, Aaron Gilbert All rights reserved.
-- 
-- About: 
--  The purpose of this script is to load configuration parameters set by the Config Tool and set variables based on 
--  existing files.
-- 
-- 
-- Legal:
--  This script is licensed under the BSD 3-Clause License. A copy of this license (as LICENSE.md) should have been included
--  with this script. If it wasn't, it can also be found here: https://www.w3.org/Consortium/Legal/2008/03-bsd-license.html
--  
--  THIS SCRIPT IS NOT MADE, DISTRIBUTED, OR SUPPORTED BY LUCASARTS, A DIVISION OF LUCASFILM ENTERTAINMENT COMPANY LTD.
-----------------------------------------------------------------
-----------------------------------------------------------------

local __SCRIPT_NAME = "ME5_ConfigCheck";
local debug = true

local function PrintLog(...)
	if debug == true then
		print("["..__SCRIPT_NAME.."]", unpack(arg));
	end
end

PrintLog("Entered")

ReadDataFile("..\\..\\addon\\ME5\\ConfigUtility\\meumodconfig.script")
ScriptCB_DoFile("meumodconfig")

meuConfigSettings = gMEUModConfig

---
-- Checks the given setting and its value based on /setting/ and /value/.
-- @param #string setting	The name of the setting file to check.
-- @param #int value		The value of the setting to check for.
-- @return 					1 if setting's value is valid, 0 if invalid. Will also return 0 if one of the function parameters wasn't inputted.
-- 
local function CheckSetting(key)
	
	-- Make sure all parameters have been inputted
	if not key then
		PrintLog("CheckSetting(): WARNING: Argument #0 'key' not set! Exiting function")
		return 0
	end
	
	return meuConfigSettings[key]
end

-- ======================
--  CUSTOM HUD
-- ======================
-- if not ScriptCB_InMultiplayer() then
	if CheckSetting("cfg_CustomHUD") == 0 then
		PrintLog("Custom HUD is DISABLED")
		ME5_CustomHUD = 0
		
	elseif CheckSetting("cfg_CustomHUD") == 1 then
		PrintLog("Custom HUD is ENABLED")
		ME5_CustomHUD = 1
		rema_noHUD = true
	else
		PrintLog("Error! ME5_CustomHUD flag not found or invalid! Defaulting to ENABLED")
		ME5_CustomHUD = 1
	end
-- else
-- 	-- rema_noHUD causes a crash in multiplayer, so we can't use it
-- 	PrintLog("We are in multiplayer so Custom HUD is DISABLED")
-- 	ME5_CustomHUD = 0
-- end

function LoadConfigSettings()
	PrintLog("Loading configuration parameters...")

	-- ======================
	--  AI HEROES
	-- ======================
	if CheckSetting("cfg_AIHeroes") == 0 then
		PrintLog("AI Heroes are DISABLED")
		ME5_AIHeroes = 0
		
	elseif CheckSetting("cfg_AIHeroes") == 1 then
		PrintLog("AI Heroes are ENABLED")
		ME5_AIHeroes = 1
		

	else
		PrintLog("Error! ME5_AIHeroes flag not found or invalid! Defaulting to ENABLED")
		ME5_AIHeroes = 1
	end


	-- ======================
	--  MENU INTERFACE STYLE
	-- ======================
	if CheckSetting("cfg_CustomGUIEnabled") == 0 then
		PrintLog("Menu Interface Style is STAR WARS BATTLEFRONT II")
		ME5_CustomGUIEnabled = 0
		
	elseif CheckSetting("cfg_CustomGUIEnabled") == 1 then
		PrintLog("Menu Interface Style is MASS EFFECT: UNIFICATION")
		ME5_CustomGUIEnabled = 1
		
	elseif CheckSetting("cfg_CustomGUIEnabled") == 2 then
		PrintLog("Menu Interface Style is MASS EFFECT 3")
		ME5_CustomGUIEnabled = 2
		
	else
		PrintLog("Error! ME5_CustomGUIEnabled flag not found or invalid! Defaulting to MASS EFFECT: UNIFICATION")
		ME5_CustomGUIEnabled = 1
	end


	-- ======================
	--  GAMEPLAY DIFFICULTY
	-- ======================
	if CheckSetting("cfg_Difficulty") == 0 then
		PrintLog("Difficulty is CASUAL")
		ME5_Difficulty = 1
		
	elseif CheckSetting("cfg_Difficulty") == 1 then
		PrintLog("Difficulty is NORMAL")
		ME5_Difficulty = 2
		
	elseif CheckSetting("cfg_Difficulty") == 2 then
		PrintLog("Difficulty is VETERAN")
		ME5_Difficulty = 3
		
	elseif CheckSetting("cfg_Difficulty") == 3 then
		PrintLog("Difficulty is HARDCORE")
		ME5_Difficulty = 4
		
	elseif CheckSetting("cfg_Difficulty") == 4 then
		PrintLog("Difficulty is INSANITY")
		ME5_Difficulty = 5
		
	else
		PrintLog("Error! ME5_Difficulty flag not found or invalid! Defaulting to VETERAN")
		ME5_Difficulty = 3
	end


	-- ======================
	--  CARNAGE MODE
	-- ======================
	if CheckSetting("cfg_CarnageMode") == 0 then
		PrintLog("Carnage Mode is DISABLED")
		ME5_CarnageMode = 0
		
	elseif CheckSetting("cfg_CarnageMode") == 1 then
		PrintLog("Carnage Mode is ENABLED")
		ME5_CarnageMode = 1
		
	else
		PrintLog("Error! ME5_CarnageMode flag not found or invalid! Defaulting to DISABLED")
		ME5_CarnageMode = 0
	end


	-- ======================
	--  HEALTH FUNCTIONALITY
	-- ======================
	if CheckSetting("cfg_HealthFunc") == 0 then
		PrintLog("Health Functionality is AUTO-REGEN")
		ME5_HealthFunc = 1
		
	elseif CheckSetting("cfg_HealthFunc") == 1 then
		PrintLog("Health Functionality is PICKUPS")
		ME5_HealthFunc = 2
		
	else
		PrintLog("Error! ME5_HealthFunc flag not found or invalid! Defaulting to AUTO-REGEN")
		ME5_HealthFunc = 1
	end


	-- ======================
	--  SHIELD FUNCTIONALITY
	-- ======================
	if CheckSetting("cfg_ShieldFunc") == 0 then
		PrintLog("Shield Functionality is REGEN")
		ME5_ShieldFunc = 1
		
	elseif CheckSetting("cfg_ShieldFunc") == 1 then
		PrintLog("Shield Functionality is PICKUPS")
		ME5_ShieldFunc = 2
		
	else
		PrintLog("Error! ME5_ShieldFunc flag not found or invalid! Defaulting to AUTO-REGEN")
		ME5_ShieldFunc = 1
	end


	-- ======================
	--  SHIELD REGEN FUNCTIONALITY
	-- ======================
	if CheckSetting("cfg_ShieldRegen") == 0 then
		PrintLog("Shield Regen Functionality (Player Only) is AUTOMATIC")
		ME5_ShieldRegen = 0
		
	elseif CheckSetting("cfg_ShieldRegen") == 1 then
		PrintLog("Shield Regen Functionality (Player Only) is DEFERRED")
		ME5_ShieldRegen = 1
		
	else
		PrintLog("Error! ME5_ShieldRegen flag not found or invalid! Defaulting to DEFERRED")
		ME5_ShieldRegen = 1
	end


	-- ======================
	--  CERBERUS HERO CLASS
	-- ======================
	if CheckSetting("cfg_HeroClassCER") == 0 then
		PrintLog("CER Hero Class is RANDOM")
		ME5_HeroClassCER = math.random(1, MAX_CER_HERO_COUNT)
		
	elseif CheckSetting("cfg_HeroClassCER") == 1 then
		PrintLog("CER Hero Class is GETH PRIME (ME2)")
		ME5_HeroClassCER = 1
		
	else
		PrintLog("Error! ME5_HeroClassCER flag not found or invalid! Defaulting to RANDOM")
		ME5_HeroClassCER = math.random(1, MAX_CER_HERO_COUNT)
	end


	-- ======================
	--  COLLECTOR HERO CLASS
	-- ======================
	if CheckSetting("cfg_HeroClassCOL") == 0 then
		PrintLog("COL Hero Class is RANDOM")
		ME5_HeroClassCOL = math.random(1, MAX_COL_HERO_COUNT)
		
	elseif CheckSetting("cfg_HeroClassCOL") == 1 then
		PrintLog("COL Hero Class is HARBINGER")
		ME5_HeroClassCOL = 1
		
	else
		PrintLog("Error! ME5_HeroClassCOL flag not found or invalid! Defaulting to RANDOM")
		ME5_HeroClassCOL = math.random(1, MAX_COL_HERO_COUNT)
	end


	-- ======================
	--  EVOLVED GETH HERO CLASS
	-- ======================
	if CheckSetting("cfg_HeroClassEVG") == 0 then
		PrintLog("EVG Hero Class is RANDOM")
		ME5_HeroClassEVG = math.random(1, MAX_EVG_HERO_COUNT)
		
	elseif CheckSetting("cfg_HeroClassEVG") == 1 then
		PrintLog("EVG Hero Class is GETH PRIME (ME2)")
		ME5_HeroClassEVG = 1
		
	elseif CheckSetting("cfg_HeroClassEVG") == 2 then
		PrintLog("EVG Hero Class is GETH PRIME (ME3)")
		ME5_HeroClassEVG = 2
		
	else
		PrintLog("Error! ME5_HeroClassEVG flag not found or invalid! Defaulting to RANDOM")
		ME5_HeroClassEVG = math.random(1, MAX_EVG_HERO_COUNT)
	end


	-- ======================
	--  HERETIC GETH HERO CLASS
	-- ======================
	if CheckSetting("cfg_HeroClassGTH") == 0 then
		PrintLog("GTH Hero Class is RANDOM")
		ME5_HeroClassGTH = math.random(1, MAX_GTH_HERO_COUNT)
		
	elseif CheckSetting("cfg_HeroClassGTH") == 1 then
		PrintLog("GTH Hero Class is GETH PRIME (ME2)")
		ME5_HeroClassGTH = 1
		
	elseif CheckSetting("cfg_HeroClassGTH") == 2 then
		PrintLog("GTH Hero Class is GETH PRIME (ME3)")
		ME5_HeroClassGTH = 2
		
	else
		PrintLog("Error! ME5_HeroClassGTH flag not found or invalid! Defaulting to RANDOM")
		ME5_HeroClassGTH = math.random(1, MAX_GTH_HERO_COUNT)
	end


	-- ======================
	--  REAPERS HERO CLASS
	-- ======================
	if CheckSetting("cfg_HeroClassRPR") == 0 then
		PrintLog("RPR Hero Class is RANDOM")
		ME5_HeroClassRPR = math.random(1, MAX_RPR_HERO_COUNT)
		
	elseif CheckSetting("cfg_HeroClassRPR") == 1 then
		PrintLog("RPR Hero Class is POSSESSED BANSHEE")
		ME5_HeroClassRPR = 1
		
	else
		PrintLog("Error! ME5_HeroClassRPR flag not found or invalid! Defaulting to RANDOM")
		ME5_HeroClassRPR = math.random(1, MAX_RPR_HERO_COUNT)
	end


	-- ======================
	--  ALLIANCE HERO CLASS
	-- ======================
	if CheckSetting("cfg_HeroClassSSV") == 0 then
		PrintLog("SSV Hero Class is RANDOM")
		ME5_HeroClassSSV = math.random(1, MAX_SSV_HERO_COUNT)
		
	elseif CheckSetting("cfg_HeroClassSSV") == 1 then
		PrintLog("SSV Hero Class is SHEPARD")
		ME5_HeroClassSSV = 1
		
	elseif CheckSetting("cfg_HeroClassSSV") == 2 then
		PrintLog("SSV Hero Class is JACK")
		ME5_HeroClassSSV = 2
		
	else
		PrintLog("Error! ME5_HeroClassSSV flag not found or invalid! Defaulting to RANDOM")
		ME5_HeroClassSSV = math.random(1, MAX_SSV_HERO_COUNT)
	end


	-- ======================
	--  SHEPARD CLASS
	-- ======================
	if CheckSetting("cfg_ShepardClass") == 0 then
		PrintLog("Shepard Class is RANDOM")
		ME5_ShepardClass = math.random(1, MAX_SHEP_CLASS_COUNT)
		
	elseif CheckSetting("cfg_ShepardClass") == 1 then
		PrintLog("Shepard Class is SOLDIER")
		ME5_ShepardClass = 1
		
	elseif CheckSetting("cfg_ShepardClass") == 2 then
		PrintLog("Shepard Class is INFILTRATOR")
		ME5_ShepardClass = 2
		
	elseif CheckSetting("cfg_ShepardClass") == 3 then
		PrintLog("Shepard Class is ENGINEER")
		ME5_ShepardClass = 3
		
	elseif CheckSetting("cfg_ShepardClass") == 4 then
		PrintLog("Shepard Class is ADEPT")
		ME5_ShepardClass = 4
		
	elseif CheckSetting("cfg_ShepardClass") == 5 then
		PrintLog("Shepard Class is SENTINEL")
		ME5_ShepardClass = 5
		
	elseif CheckSetting("cfg_ShepardClass") == 6 then
		PrintLog("Shepard Class is VANGUARD")
		ME5_ShepardClass = 6
		
	else
		PrintLog("Error! ME5_ShepardClass flag not found or invalid! Defaulting to RANDOM")
		ME5_ShepardClass = math.random(1, MAX_SHEP_CLASS_COUNT)
	end


	-- ======================
	--  SHEPARD GENDER
	-- ======================
	if CheckSetting("cfg_ShepardGender") == 0 then
		PrintLog("Shepard Gender is RANDOM")
		ME5_ShepardGender = math.random(1, MAX_SHEP_GENDER_COUNT)
		
	elseif CheckSetting("cfg_ShepardGender") == 1 then
		PrintLog("Shepard Gender is MALE")
		ME5_ShepardGender = 1
		
	elseif CheckSetting("cfg_ShepardGender") == 2 then
		PrintLog("Shepard Gender is FEMALE")
		ME5_ShepardGender = 2
		
	else
		PrintLog("Error! ME5_ShepardGender flag not found or invalid! Defaulting to RANDOM")
		ME5_ShepardGender = math.random(1, MAX_SHEP_GENDER_COUNT)
	end

	shepardGenderSuffix = ""
	femShepEnabled = false
	if ME5_ShepardGender == 2 then
		shepardGenderSuffix = "_fem"
		femShepEnabled = true
	end


	-- ======================
	--  SIDE VARIATION
	-- ======================
	if CheckSetting("cfg_SideVar") == 0 then
		PrintLog("Side Variation is RANDOM")
		ME5_SideVar = math.random(1, MAX_FACTION_COUNT)
		
	elseif CheckSetting("cfg_SideVar") == 1 then
		PrintLog("Side Variation is SSVxGTH")
		ME5_SideVar = 1
		
	elseif CheckSetting("cfg_SideVar") == 2 then
		PrintLog("Side Variation is SSVxCOL")
		ME5_SideVar = 2
		
	elseif CheckSetting("cfg_SideVar") == 3 then
		PrintLog("Side Variation is EVGxGTH")
		ME5_SideVar = 3
		
	elseif CheckSetting("cfg_SideVar") == 4 then
		PrintLog("Side Variation is EVGxCOL")
		ME5_SideVar = 4
		
	elseif CheckSetting("cfg_SideVar") == 5 then
		PrintLog("Side Variation is SSVxRPR")
		ME5_SideVar = 5
		
	elseif CheckSetting("cfg_SideVar") == 6 then
		PrintLog("Side Variation is SSVxCER")
		ME5_SideVar = 6
		
	else
		PrintLog("Error! ME5_SideVar flag not found or invalid! Defaulting to RANDOM")
		ME5_SideVar = math.random(1, MAX_FACTION_COUNT)
	end


	-- ======================
	--  EDEN PRIME WEATHER
	-- ======================
	if not ScriptCB_InMultiplayer() then
		if CheckSetting("cfg_MapVarEDN") == 0 then
			PrintLog("Eden Prime Weather is RANDOM")
			ME5_MapVarEDN = math.random(1,3)
			
		elseif CheckSetting("cfg_MapVarEDN") == 1 then
			PrintLog("Eden Prime Weather is STORMY")
			ME5_MapVarEDN = 1
			
		elseif CheckSetting("cfg_MapVarEDN") == 2 then
			PrintLog("Eden Prime Weather is CLOUDY")
			ME5_MapVarEDN = 2
			
		elseif CheckSetting("cfg_MapVarEDN") == 3 then
			PrintLog("Eden Prime Weather is DUSK")
			ME5_MapVarEDN = 3
			
		else
			PrintLog("Error! ME5_MapVarEDN flag not found or invalid! Defaulting to RANDOM")
			ME5_MapVarEDN = math.random(1,3)
		end
	else
		PrintLog("Eden Prime Weather is CLOUDY")
		ME5_MapVarEDN = 2
	end


	-- ======================
	--  SOL MAP MUSIC
	-- ======================
	if CheckSetting("cfg_SolMapMusic") == 0 then
		PrintLog("'Sol Map Pack' Map Music is AMBIENT SOUNDSCAPE")
		ME5_SolMapMusic = 0
		
	elseif CheckSetting("cfg_SolMapMusic") == 1 then
		PrintLog("'Sol Map Pack' Map Music is MASS EFFECT")
		ME5_SolMapMusic = 1
		
	else
		PrintLog("Error! ME5_SolMapMusic flag not found or invalid! Defaulting to AMBIENT SOUNDSCAPE")
		ME5_SolMapMusic = 0
	end


	-- ======================
	--  FACTION ANNOUNCER VO
	-- ======================
	if CheckSetting("cfg_FactionVO") == 0 then
		PrintLog("Faction Announcer VO is DISABLED")
		ME5_FactionVO = 0
		
	elseif CheckSetting("cfg_FactionVO") == 1 then
		PrintLog("Faction Announcer VO is QUIET")
		ME5_FactionVO = 1
		
	elseif CheckSetting("cfg_FactionVO") == 2 then
		PrintLog("Faction Announcer VO is LOUD")
		ME5_FactionVO = 2
		
	else
		PrintLog("Error! ME5_FactionVO flag not found or invalid! Defaulting to LOUD")
		ME5_FactionVO = 2
	end


	-- ======================
	--  LOW HEALTH SOUND
	-- ======================
	if CheckSetting("cfg_LowHealthSound") == 0 then
		PrintLog("'Low Health' Feedback Sounds are DISABLED")
		ME5_LowHealthSound = 0
		
	elseif CheckSetting("cfg_LowHealthSound") == 1 then
		PrintLog("'Low Health' Feedback Sounds are ENABLED")
		ME5_LowHealthSound = 1
		
	else
		PrintLog("Error! ME5_LowHealthSound flag not found or invalid! Defaulting to ENABLED")
		ME5_LowHealthSound = 1
	end


	-- ======================
	--  KILL SOUND
	-- ======================
	if CheckSetting("cfg_KillSound") == 0 then
		PrintLog("'Enemy Killed' Feedback Sounds are DISABLED")
		ME5_KillSound = 0
		
	elseif CheckSetting("cfg_KillSound") == 1 then
		PrintLog("'Enemy Killed' Feedback Sounds are QUIET")
		ME5_KillSound = 1
		
	elseif CheckSetting("cfg_KillSound") == 2 then
		PrintLog("'Enemy Killed' Feedback Sounds are LOUD")
		ME5_KillSound = 2
		
	else
		PrintLog("Error! ME5_KillSound flag not found or invalid! Defaulting to LOUD")
		ME5_KillSound = 2
	end


	-- ======================
	--  PLAYER DAMAGE SOUNDS
	-- ======================
	if CheckSetting("cfg_PlayerDmgSound") == 0 then
		PrintLog("'Player Damaged' Feedback Sounds are DISABLED")
		ME5_PlayerDmgSound = 0
		
	elseif CheckSetting("cfg_PlayerDmgSound") == 1 then
		PrintLog("'Player Damaged' Feedback Sounds are QUIET")
		ME5_PlayerDmgSound = 1
		
	elseif CheckSetting("cfg_PlayerDmgSound") == 2 then
		PrintLog("'Player Damaged' Feedback Sounds are LOUD")
		ME5_PlayerDmgSound = 2
		
	else
		PrintLog("Error! ME5_PlayerDmgSound flag not found or invalid! Defaulting to LOUD")
		ME5_PlayerDmgSound = 2
	end


	-- ======================
	--  HIT MARKER SOUNDS
	-- ======================
	if CheckSetting("cfg_HitMarkerSound") == 0 then
		PrintLog("Hit Marker Sounds are DISABLED")
		ME5_HitMarkerSound = 0
		
	elseif CheckSetting("cfg_HitMarkerSound") == 1 then
		PrintLog("Hit Marker Sounds are QUIET")
		ME5_HitMarkerSound = 1
		
	elseif CheckSetting("cfg_HitMarkerSound") == 2 then
		PrintLog("Hit Marker Sounds are LOUD")
		ME5_HitMarkerSound = 2
		
	else
		PrintLog("Error! ME5_HitMarkerSound flag not found or invalid! Defaulting to LOUD")
		ME5_HitMarkerSound = 2
	end

	PrintLog("Checking configuration parameters... Done!")


	-- Call the AI hero support script if AI heroes are enabled
	if ME5_AIHeroes == 1 then
		ScriptCB_DoFile("ME5_AIHeroSupport")
	end

	-- Determines Shepard's class.
	function DecideShepClass()
		if ME5_ShepardClass == 1 then
			PrintLog("DecideShepClass(): Deciding Shepard class... SOLDIER")
			SSVHeroClass = "ssv_hero_shepard_soldier"..shepardGenderSuffix
			
		elseif ME5_ShepardClass == 2 then
			PrintLog("DecideShepClass(): Deciding Shepard class... INFILTRATOR")
			SSVHeroClass = "ssv_hero_shepard_infiltrator"..shepardGenderSuffix
			
		elseif ME5_ShepardClass == 3 then
			PrintLog("DecideShepClass(): Deciding Shepard class... ENGINEER")
			SSVHeroClass = "ssv_hero_shepard_engineer"..shepardGenderSuffix
			
		elseif ME5_ShepardClass == 4 then
			PrintLog("DecideShepClass(): Deciding Shepard class... ADEPT")
			SSVHeroClass = "ssv_hero_shepard_adept"..shepardGenderSuffix
			
		elseif ME5_ShepardClass == 5 then
			PrintLog("DecideShepClass(): Deciding Shepard class... SENTINEL")
			SSVHeroClass = "ssv_hero_shepard_sentinel"..shepardGenderSuffix
			
		elseif ME5_ShepardClass == 6 then
			PrintLog("DecideShepClass(): Deciding Shepard class... VANGUARD")
			SSVHeroClass = "ssv_hero_shepard_vanguard"..shepardGenderSuffix
		else
			PrintLog("DecideShepClass(): Error! ME5_ShepardClass is invalid! Defaulting to SOLDIER")
			SSVHeroClass = "ssv_hero_shepard_soldier"..shepardGenderSuffix
		end
	end

	-- Determines the Systems Alliance's hero unit.
	function DecideSSVHeroClass()
		if ME5_HeroClassSSV == 1 then
			PrintLog("DecideSSVHeroClass(): Deciding SSV hero class... SHEPARD")
			DecideShepClass()
			
		elseif ME5_HeroClassSSV == 2 then
			PrintLog("DecideSSVHeroClass(): Deciding SSV hero class... JACK")
			SSVHeroClass = "ssv_hero_jack"
			
		--[[elseif ME5_HeroClassSSV == 3 then
			PrintLog("DecideSSVHeroClass(): Deciding SSV hero class... SAMARA")
			SSVHeroClass = "ssv_hero_samara"
			
		elseif ME5_HeroClassSSV == 4 then
			PrintLog("DecideSSVHeroClass(): Deciding SSV hero class... LEGION")
			SSVHeroClass = "ssv_hero_legion"]]
		else
			PrintLog("DecideSSVHeroClass(): Error! ME5_HeroClassSSV value is invalid! Defaulting to SHEPARD")
			DecideShepClass()
		end
	end

	-- Determines the Heretic Geth's hero unit.
	function DecideGTHHeroClass()
		if ME5_HeroClassGTH == 1 then
			PrintLog("DecideGTHHeroClass(): Deciding GTH hero class... GETH PRIME (ME2)")
			GTHHeroClass = "gth_hero_prime_me2"
			
		elseif ME5_HeroClassGTH == 2 then
			PrintLog("DecideGTHHeroClass(): Deciding GTH hero class... GETH PRIME (ME3)")
			GTHHeroClass = "gth_hero_prime_me3"
			
		else
			PrintLog("DecideGTHHeroClass(): Error! ME5_HeroClassGTH value is invalid! Defaulting to GETH PRIME (ME2)")
			GTHHeroClass = "gth_hero_prime_me2"
		end
	end

	-- Determines the Collectors' hero unit.
	function DecideCOLHeroClass()
		if ME5_HeroClassCOL == 1 then
			PrintLog("DecideCOLHeroClass(): Deciding COL hero class... HARBINGER")
			COLHeroClass = "col_hero_harbinger"
		else
			PrintLog("DecideCOLHeroClass(): Error! ME5_HeroClassCOL value is invalid! Defaulting to HARBINGER")
			COLHeroClass = "col_hero_harbinger"
		end
	end

	-- Determines the Evolved Geth's hero unit.
	function DecideEVGHeroClass()
		if ME5_HeroClassEVG == 1 then
			PrintLog("DecideEVGHeroClass(): Deciding EVG hero class... GETH PRIME (ME2)")
			EVGHeroClass = "gth_hero_prime_me2"
		elseif ME5_HeroClassEVG == 2 then
			PrintLog("DecideEVGHeroClass(): Deciding EVG hero class... GETH PRIME (ME3)")
			EVGHeroClass = "gth_hero_prime_me3"
		else
			PrintLog("DecideEVGHeroClass(): Error! ME5_HeroClassEVG value is invalid! Defaulting to GETH PRIME (ME3)")
			EVGHeroClass = "gth_hero_prime_me3"
		end
	end

	-- Determines the Reaper Forces' hero unit.
	function DecideRPRHeroClass()
		if ME5_HeroClassRPR == 1 then
			PrintLog("DecideRPRHeroClass(): Deciding RPR hero class... POSSESSED BANSHEE")
			RPRHeroClass = "rpr_hero_banshee"
		else
			PrintLog("DecideRPRHeroClass(): Error! ME5_HeroClassRPR value is invalid! Defaulting to POSSESSED BANSHEE")
			RPRHeroClass = "rpr_hero_banshee"
		end
	end

	-- Determines Cerberus's hero unit.
	function DecideCERHeroClass()
		if ME5_HeroClassCER == 1 then
			PrintLog("DecideCERHeroClass(): Deciding CER hero class... KAI LENG")
			CERHeroClass = "cer_hero_kaileng"
		else
			PrintLog("DecideEVGHeroClass(): Error! ME5_HeroClassCER value is invalid! Defaulting to KAI LENG")
			CERHeroClass = "cer_hero_kaileng"
		end
	end

	if not ScriptCB_InMultiplayer() then
		DecideSSVHeroClass()
		DecideGTHHeroClass()
		DecideCOLHeroClass()
		DecideEVGHeroClass()
		DecideRPRHeroClass()
		DecideCERHeroClass()
	end
end

function LoadVirmireSettings()
	-- ======================
	--  VIRMIRE PLAY AREA
	-- ======================
	if not ScriptCB_InMultiplayer() then
		if CheckSetting("cfg_MapVarVRM") == 0 then
			PrintLog("Virmire Play Area is RANDOM")
			ME5_MapVarVRM = math.random(1,2)
			
		elseif CheckSetting("cfg_MapVarVRM") == 1 then
			PrintLog("Virmire Play Area is UPPER LEVEL")
			ME5_MapVarVRM = 1
			
		elseif CheckSetting("cfg_MapVarVRM") == 2 then
			PrintLog("Virmire Play Area is LOWER LEVEL")
			ME5_MapVarVRM = 2
			
		else
			PrintLog("Error! ME5_MapVarVRM flag not found or invalid! Defaulting to RANDOM")
			ME5_MapVarVRM = math.random(1,2)
		end
	else
		PrintLog("Virmire Play Area is UPPER LEVEL")
		ME5_MapVarVRM = 1
	end
end

PrintLog("Exited")