ARXManager.lua

-- ===========================================================================
--	Logitech ARX Support
-- ===========================================================================
include("TabSupport");
include("InstanceManager");
include("SupportFunctions");
include("AnimSidePanelSupport");
include("TeamSupport");

-- ===========================================================================
--	CONSTANTS
-- ===========================================================================

-- ===========================================================================
--	VARIABLES
-- ===========================================================================
local m_ScreenMode:number = 0;
local m_LocalPlayer:table;
local m_LocalPlayerID:number;
local fullStr:string = "";
local m_kEras:table	= {};
local m_bIsPortrait:boolean = false;

-- ===========================================================================
-- Draw the Top 5 Civs screen
-- ===========================================================================
function DrawTop5()
    local civsShown:number = 0;
	local numPlayers:number = 0;
	local playersData:table = {};
    for i = 0, PlayerManager.GetWasEverAliveCount() - 1 do
		local pPlayer = Players[i];
        local lTeamID = -1;
        local team = Teams[pPlayer:GetTeam()];
        if(team ~= nil and #team ~= 1) then
            lTeamID = pPlayer:GetTeam();
        end

		if (pPlayer:IsAlive() == true and pPlayer:IsMajor() == true) then
			table.insert(playersData, {
				Player = pPlayer,
				Score = pPlayer:GetScore(),
                OriginalID = i,
                TeamID = lTeamID;
			});
			numPlayers = numPlayers + 1;
		end
	end

	if(numPlayers > 0) then
		-- Sort players by Score
		table.sort(playersData, function(a, b)
			if (a.Score == b.Score) then
                return a.Player:GetID() < b.Player:GetID();
			end
			return a.Score > b.Score;
		end);
    end

    -- now walk the sorted list of civs
    for iPlayer = 1, numPlayers do
        if civsShown < 5 then
            local pPlayer = playersData[iPlayer].Player;
            if (pPlayer:IsAlive() == true and pPlayer:IsMajor() == true) then
                local pID = pPlayer:GetID();
                local playerConfig:table = PlayerConfigurations[pID];

				local bHasMet = false;
				if(m_LocalPlayer) then
					bHasMet = m_LocalPlayer:GetDiplomacy():HasMet(playersData[iPlayer].OriginalID);
				end

                local name:string;
                local teamName:string;
                local imgname:string;
                local detailsText:string = "";
                local scoreCategories = GameInfo.ScoringCategories;
                local numCategories:number = #scoreCategories;
                local bUseTick = false;
                for i = 0, numCategories - 1 do
                    if scoreCategories[i].Multiplier > 0 then
                        local category:table = scoreCategories[i];
                        if bUseTick then
                            detailsText = detailsText .. " - ";
                        end
                        if category.Name == "LOC_CATEGORY_INCOME_NAME" then
                            detailsText = detailsText .. Locale.Lookup("LOC_HUD_REPORTS_TOTAL_INCOME_PER_TURN") .. "&nbsp; " .. pPlayer:GetCategoryScore(i);
                            -- " <img src=ICON_Gold.png/>";
                        else
                            detailsText = detailsText .. Locale.Lookup(category.Name) .. ":&nbsp;" .. pPlayer:GetCategoryScore(i);
                        end
                        bUseTick = true;
                    end
                end

                if (bHasMet == true or pID == Game.GetLocalPlayer() or GameConfiguration.IsHotseat()) then
                    name = Locale.Lookup(playerConfig:GetPlayerName());
                    imgname = Locale.Lookup(playerConfig:GetLeaderTypeName());
                    -- Civ name and score
                    if playersData[iPlayer].TeamID ~= -1 then
                        teamName = GameConfiguration.GetTeamName(playersData[iPlayer].TeamID); 
                        fullStr = fullStr.."<p><span class=title><img src='Civ_"..imgname..".png' align=left>"..name.." ("..Locale.Lookup("LOC_WORLD_RANKINGS_TEAM", teamName).."): "..Locale.Lookup("LOC_WORLD_RANKINGS_SCORE_TAB")..":  "..pPlayer:GetScore().."</span><br>";
                    else
                        fullStr = fullStr.."<p><span class=title><img src='Civ_"..imgname..".png' align=left>"..name..": "..Locale.Lookup("LOC_WORLD_RANKINGS_SCORE_TAB")..":  "..pPlayer:GetScore().."</span><br>";
                    end
                else
                    name = Locale.Lookup("LOC_WORLD_RANKING_UNMET_PLAYER");
                    -- Civ name and score
                    fullStr = fullStr.."<p><img src=Civ_Unmet.png align=left><span class=title>"..name..": "..Locale.Lookup("LOC_WORLD_RANKINGS_SCORE_TAB")..":  "..pPlayer:GetScore().."</span><br>";
                end

                -- Civ scoring info
                fullStr = fullStr.."<span class=content>"..detailsText.."</span>";       

                civsShown = civsShown + 1;
            end
        end                
    end

    UI.SetARXTagContentByID("Content", fullStr);
end                              

-- ===========================================================================
-- Draw the Victory Progress screen
-- ===========================================================================
function PopulateVictoryType(victoryType:string, typeText:string)
    fullStr = fullStr.."<p><span class=title>"..Locale.Lookup(typeText);

    -- Tiebreak score functions
	local firstTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_DOMINATION_SCORE";
	local firstTiebreakerFunction = function(p)
		return p:GetScore();
	end;
	local secondTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_DOMINATION_SCORE";
	local secondTiebreakerFunction = function(p)
		return p:GetScore();
	end;
	if (victoryType == "VICTORY_TECHNOLOGY") then
		firstTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_SCIENCE_NUM_TECHS";
		firstTiebreakerFunction = function(p)
			return p:GetStats():GetNumTechsResearched();
		end;
		secondTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_SCIENCE_SCIENCE_RATE";
		secondTiebreakerFunction = function(p)
			return p:GetTechs():GetScienceYield();
		end;
	elseif (victoryType == "VICTORY_CULTURE") then
		firstTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_CULTURE_TOURISM_RATE";
		firstTiebreakerFunction = function(p)
			return p:GetStats():GetTourism();
		end;
		secondTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_CULTURE_CULTURE_RATE";
		secondTiebreakerFunction = function(p)
			return p:GetCulture():GetCultureYield();
		end;
	elseif (victoryType == "VICTORY_CONQUEST") then
		firstTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_DOMINATION_MILITARY_STRENGTH";
		firstTiebreakerFunction = function(p)
			return p:GetStats():GetMilitaryStrength();
		end;
	elseif (victoryType == "VICTORY_RELIGIOUS") then
		firstTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_RELIGION_CITIES_FOLLOWING_RELIGION";
		firstTiebreakerFunction = function(p)
			return p:GetStats():GetNumCitiesFollowingReligion();
		end;
		secondTiebreakerText = "LOC_WORLD_RANKINGS_OVERVIEW_RELIGION_FAITH_RATE";
		secondTiebreakerFunction = function(p)
			return p:GetReligion():GetFaithYield();
		end;
	end

	local numPlayers:number = 0;
	local playersData:table = {};
	for i = 0, PlayerManager.GetWasEverAliveCount() - 1 do
		local pPlayer = Players[i];
		if (pPlayer:IsAlive() == true and pPlayer:IsMajor() == true) then
			table.insert(playersData, {
				Player = pPlayer,
				Score = Game.GetVictoryProgressForTeam(victoryType, pPlayer:GetTeam()), -- Game Core Call
				FirstTiebreakScore = firstTiebreakerFunction(pPlayer),
				SecondTiebreakScore = secondTiebreakerFunction(pPlayer),
				FirstTiebreakSummary = Locale.Lookup(firstTiebreakerText, Round(firstTiebreakerFunction(pPlayer), 1)),
				SecondTiebreakSummary = Locale.Lookup(secondTiebreakerText, Round(secondTiebreakerFunction(pPlayer), 1)),
			});
			numPlayers = numPlayers + 1;
		end
	end

	if(numPlayers > 0) then
		-- Sort players by Score, including tiebreakers
		table.sort(playersData, function(a, b)
			if (a.Score == b.Score) then
				if (a.FirstTiebreakScore == b.FirstTiebreakScore) then
					if (a.SecondTiebreakScore == b.SecondTiebreakScore) then
						return a.Player:GetID() < b.Player:GetID();
					end
					return a.SecondTiebreakScore > b.SecondTiebreakScore;
				end
				return a.FirstTiebreakScore > b.FirstTiebreakScore;
			end
			return a.Score > b.Score;
		end);

		local topPlayer:number = playersData[1].Player:GetID();
		if(topPlayer == m_LocalPlayerID) then
            fullStr = fullStr..Locale.Lookup("LOC_WORLD_RANKINGS_FIRST_PLACE_YOU_SIMPLE");
		else
			-- Determine local player position
			local localPlayerPosition:number = 1;
			local localPlayerPositionText:string;
			local localPlayerPositionLocTag:string;
			for i = 1, numPlayers do
				if(playersData[i].Player == m_LocalPlayer) then
					localPlayerPosition = i;
					break;
				end
			end

			-- Generate position text (ex: "You are in third place" or "You are in position 15")
			if(localPlayerPosition <= 12) then
				localPlayerPositionText = Locale.Lookup("LOC_WORLD_RANKINGS_" .. localPlayerPosition .. "_PLACE");
				localPlayerPositionLocTag = "LOC_WORLD_RANKINGS_OTHER_PLACE_";
			else
				localPlayerPositionText = tostring(localPlayerPosition);
				localPlayerPositionLocTag = "LOC_WORLD_RANKINGS_OTHER_POSITION_";
			end
			localPlayerPositionLocTag = localPlayerPositionLocTag .. "SIMPLE";
			fullStr = fullStr..Locale.Lookup(localPlayerPositionLocTag, localPlayerPositionText);
        end
    end

    fullStr = fullStr.."</span>";
end

local STANDARD_VICTORY_TYPES:table = {
	"VICTORY_TECHNOLOGY",
	"VICTORY_CULTURE",
	"VICTORY_CONQUEST",
	"VICTORY_RELIGIOUS"
};

function IsCustomVictoryType(victoryType:string)
	for _, checkVictoryType in ipairs(STANDARD_VICTORY_TYPES) do
		if victoryType == checkVictoryType then
			return false;
		end
	end
	return true;
end

function DrawVictoryProgress()
    local strDate = Calendar.MakeYearStr(Game.GetCurrentGameTurn());
    local playerConfig:table = PlayerConfigurations[Game.GetLocalPlayer()];
    local name:string = Locale.Lookup(playerConfig:GetPlayerName());
    local bShownAType = false;

    fullStr = fullStr.."<p><span class=title>" .. Locale.Lookup("LOC_ARX_VICTORY_PROGRESS", name) .."</span><br><br>";

	if(Game.IsVictoryEnabled("VICTORY_TECHNOLOGY")) then
		PopulateVictoryType("VICTORY_TECHNOLOGY", "<img src=Victory_Science.png align=left>" .. Locale.Lookup("LOC_WORLD_RANKINGS_SCIENCE_TAB").."<br>");
        bShownAType = true;
	end
	if(Game.IsVictoryEnabled("VICTORY_CULTURE")) then
		PopulateVictoryType("VICTORY_CULTURE", "<img src=Victory_Culture.png align=left>" .. Locale.Lookup("LOC_WORLD_RANKINGS_CULTURE_TAB").."<br>");
        bShownAType = true;
	end
	if(Game.IsVictoryEnabled("VICTORY_CONQUEST")) then
		PopulateVictoryType("VICTORY_CONQUEST", "<img src=Victory_Domination.png align=left>" .. Locale.Lookup("LOC_WORLD_RANKINGS_DOMINATION_TAB").."<br>");
        bShownAType = true;
	end
	if(Game.IsVictoryEnabled("VICTORY_RELIGIOUS")) then
		PopulateVictoryType("VICTORY_RELIGIOUS", "<img src=Victory_Religion.png align=left>" .. Locale.Lookup("LOC_WORLD_RANKINGS_RELIGION_TAB").."<br>");
        bShownAType = true;
	end

	-- Add custom (modded) victory types
	for row in GameInfo.Victories() do
		local victoryType:string = row.VictoryType;
		if IsCustomVictoryType(victoryType) and Game.IsVictoryEnabled(victoryType) and not bShownAType then
            fullStr = fullStr .. Locale.Lookup("LOC_HUD_CITY_NOT_APPLICABLE");
            bShownAType = true;
		end
	end

    if not bShownAType then
        fullStr = fullStr .. Locale.Lookup("LOC_HUD_CITY_NOT_APPLICABLE"); 
    end

    UI.SetARXTagContentByID("Content", fullStr);
end

-- ===========================================================================
-- Draw the Gossip Log screen
-- ===========================================================================
function DrawGossipLog()
    local strDate = Calendar.MakeYearStr(Game.GetCurrentGameTurn());
    local iNumAdded:number = 0;
    local iMaxAdded:number;
    local playerConfig:table = PlayerConfigurations[Game.GetLocalPlayer()];
    local name:string = Locale.Lookup(playerConfig:GetPlayerName());

    if m_bIsPortrait then
        iMaxAdded = 35;
    else
        iMaxAdded = 22;
    end

    fullStr = fullStr.."<p><span class=title>"..name.." "..Locale.Lookup("LOC_DIPLOMACY_INTEL_GOSSIP_COLON").."</span><br>";

    --Only show the gossip generated in the last 100 turns.  Otherwise we can end up with a TON of gossip, and everything bogs down.
    for iPlayer = 0, PlayerManager.GetWasEverAliveCount() - 1 do
    	local gossipManager = Game.GetGossipManager();
    	local iCurrentTurn = Game.GetCurrentGameTurn();
    	local earliestTurn = iCurrentTurn - 100;
    	local gossipStringTable = gossipManager:GetRecentVisibleGossipStrings(earliestTurn, m_LocalPlayerID, iPlayer);
    	for i, currTable:table in pairs(gossipStringTable) do

    		local gossipString = currTable[1];
    		local gossipTurn = currTable[2];

    		if (gossipString ~= nil) then
                if iNumAdded < iMaxAdded then
                    fullStr = fullStr..gossipString.."</br>";
                    iNumAdded = iNumAdded + 1;
                end
    		else
    			break;
    		end
    	end
    end

    if iNumAdded == 0 then
        fullStr = fullStr..Locale.Lookup("LOC_DIPLOMACY_GOSSIP_ITEM_NONE_THIS_TURN").."</p>";
    end

    UI.SetARXTagContentByID("Content", fullStr);
end

-- ===========================================================================
-- Clear ARX if exiting to main menu
-- ===========================================================================
function OnExitToMain()
    UI.SetARXTagContentByID("top5", " ");
    UI.SetARXTagContentByID("victory", " ");
    UI.SetARXTagContentByID("gossip", " ");
    UI.SetARXTagContentByID("Content", " ");
end

-- ===========================================================================
-- Refresh the ARX screen
-- ===========================================================================
function RefreshARX()
    if UI.HasARX() then
        local strDate = Calendar.MakeYearStr(Game.GetCurrentGameTurn());

        m_bIsPortrait = UI.IsARXDisplayPortrait();
		
        if (Game.GetLocalPlayer() ~= -1) then
            m_LocalPlayer = Players[Game.GetLocalPlayer()];
            m_LocalPlayerID = m_LocalPlayer:GetID();
        end

        -- fill in button texts (generating full button HTML here fails for an unknown reason, may have to use JavaScript to be fully dynamic)
        UI.SetARXTagContentByID("top5", "<span class=content>"..Locale.Lookup("LOC_ARX_TOP_5").."</span>");
        UI.SetARXTagContentByID("victory", "<span class=content>"..Locale.Lookup("LOC_VICTORYSTATUS_PANEL_HEADER").."</span>");
        UI.SetARXTagContentByID("gossip", "<span class=content>"..Locale.Lookup("LOC_ARX_GOSSIP_LOG").."</span>");

        -- make buttons visible
        UI.SetARXTagsPropertyByClass("button", "style.visibility", "visible");

        -- header with civ name
		local playerName;
		if(m_LocalPlayerID and PlayerConfigurations[m_LocalPlayerID]) then
            local bOnTeam = false;
            local team = Teams[m_LocalPlayer:GetTeam()];
            if(team ~= nil and #team ~= 1) then
                bOnTeam = true;
            end

            if bOnTeam then
                playerName = Locale.Lookup(PlayerConfigurations[m_LocalPlayerID]:GetPlayerName())..", "..Locale.Lookup("LOC_WORLD_RANKINGS_TEAM", m_LocalPlayer:GetTeam());
            else
                playerName = Locale.Lookup(PlayerConfigurations[m_LocalPlayerID]:GetPlayerName());
            end
		else
			playerName = Locale.Lookup("LOC_MULTIPLAYER_UNKNOWN");
		end

        fullStr = "<span class=title>".. playerName .."</span>";
        -- and turn and date
		fullStr = fullStr.."<br><span class=content>" .. Locale.Lookup("LOC_TOP_PANEL_CURRENT_TURN").." "..tostring(Game.GetCurrentGameTurn());

        if m_bIsPortrait then
            fullStr = fullStr..", "..strDate;
        else
            fullStr = fullStr..", "..strDate;
        end
                       
		local eraName;
		if(m_LocalPlayer) then
			local eraIndex:number = m_LocalPlayer:GetEra() + 1;
			for _,era in pairs(m_kEras) do
				if era.Index == eraIndex then
					eraName = Locale.Lookup("LOC_GAME_ERA_DESC", era.Description );
					break;
				end		
			end
		else
			eraName = Locale.Lookup("LOC_MULTIPLAYER_UNKNOWN");
		end    

		fullStr = fullStr..", ".. eraName .."</span>";

        if m_ScreenMode == 0 then
            DrawTop5();
        end
        if m_ScreenMode == 1 then
            DrawVictoryProgress();
        end
        if m_ScreenMode == 2 then
            DrawGossipLog();
        end
    end
end

-- ===========================================================================
-- Handle turn change
-- ===========================================================================
function OnTurnBegin()
    RefreshARX();
end

-- ===========================================================================
-- Handle ARX taps
-- ===========================================================================
function OnARXTap(szButtonID:string)
    if szButtonID == "top5" then
        m_ScreenMode = 0;
	end
    if szButtonID == "victory" then
        m_ScreenMode = 1;
	end
    if szButtonID == "gossip" then
        m_ScreenMode = 2;
    end

    RefreshARX();
end

-- ===========================================================================
--	Reset the hooks that are visible for hotseat
-- ===========================================================================
function OnLocalPlayerChanged()
	RefreshARX();
end

-- ===========================================================================
--	Update our scores when a city is captured
-- ===========================================================================
function OnCityOccupationChanged(player, cityID)
    RefreshARX();
end

-- ===========================================================================
function Initialize()

	Events.LocalPlayerChanged.Add( OnLocalPlayerChanged );
	Events.TurnBegin.Add( OnTurnBegin );
    Events.ARXTap.Add( OnARXTap );
    Events.ARXOrientationChanged.Add( RefreshARX );
    Events.ExitToMainMenu.Add( OnExitToMain );
	Events.CityOccupationChanged.Add( OnCityOccupationChanged );	

    -- build era table
	m_kEras = {};
	for row:table in GameInfo.Eras() do
		m_kEras[row.EraType] = { 
			Description	= Locale.Lookup(row.Name),
			Index		= row.ChronologyIndex,
		}
	end	

    OnTurnBegin();
end
Initialize();