UTGame.UTUIScene_MidGameMenu

/**
 * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
 */

class UTUIScene_MidGameMenu extends UTUIScene_Hud
	dependson(UTUIScene_MessageBox)
	native(UI);

var transient UTUIButtonBar	ButtonBar;
var transient UTUITabControl TabControl;
var transient UILabel MapVoteClock;
var transient UIPanel LoadingPanel;
var transient UIImage LoadingRotator;
var transient UILabel LoadingLabel;
var transient bool bInitial;

var transient bool bNeedsProfileSave;
var transient bool bOkToAutoClose;

var transient UTUITabPage_InGame InGamePage;
var transient UTUITabPage_VoteTab VotePage;

var transient bool bLoading;
var transient bool bWaitingForReady;
var transient bool bReturningToMainMenu;
var transient bool bWasDownloading;

var transient UTUIScene_MessageBox MBScene;

// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)


event SceneActivated( bool bInitialActivation )
{
	local WorldInfo WI;
	local int i,cnt;
	local UTPlayerController UTPC;

	Super.SceneActivated(bInitialActivation);

	if ( bInitialActivation )
	{
		UTPC = GetUTPlayerOwner();
		if ( UTPC != None )
		{
			// SceneActivated is called immediately after LoadSceneDataValues is called.  LoadSceneDataValues would caused
			// most of the widgets in the scene which are bound to the player profile's data store to re-initialize their value,
			// triggering a call to their ValueChanged delegate.  In the mid-game menu, the handler for this delegate sets the
			// "profile is dirty" flag in scene, but in the case of LoadSceneDataValues the profile isn't dirty so clear that
			// flag now.
			bNeedsProfileSave = false;
		}

		WI = GetWorldInfo();
		if ( WI != none && WI.GRI != none )
		{
			for (i=0;i<WI.GRI.PRIArray.Length;i++)
			{
				if ( WI.GRI.PRIArray[i] != none && !WI.GRI.PRIArray[i].bBot)
				{
					cnt++;
				}
			}

			if ((!WI.GRI.bMatchIsOver && Cnt < 2) || (WI.NetMode == NM_Client && DemoRecSpectator(UTPC) != None))
			{
				bPauseGameWhileActive = true;
			}
		}

		//RemoveGameVoteTab();	 //We want the GameTab back
	}
}

event SceneDeactivated()
{
	local WorldInfo WI;
	local UTGameReplicationInfo GRI;
	local UTPlayerController UTPC;

	Super.SceneDeactivated();

	UTPC = GetUTPlayerOwner();

	WI = GetWorldInfo();
    WI.ForceGarbageCollection();

	if (bNeedsProfileSave)
	{
		UTPC.SaveProfile(GetPlayerIndex());
		UTPC.LoadSettingsFromProfile(false);
	}

	GRI = UTGameReplicationInfo(WI.GRI);
	if ( GRI != none )
	{
		GRI.LastUsedMidgameTab = TabControl.ActivePage.WidgetTag;
		GRI.MidGameMenuClosed();

		if (GRI.bMatchIsOver && !bReturningToMainMenu)
		{
			UTPC.ShowScoreboard();
		}
    }
}

/**
 * Setup the delegates for the scene and cache all of the various UI Widgets
 */
event PostInitialize( )
{
	local class<UTGame> GameClass;
	local UTPlayerController PC;

	Super.PostInitialize();

	// Store a reference to the button bar.
	ButtonBar = UTUIButtonBar(FindChild('ButtonBar', true));
	ButtonBar.ClearButton(0);
	ButtonBar.ClearButton(1);

	LoadingPanel = UIPanel(FindChild('LoadingPanel',true));
	LoadingRotator = UIImage(FindChild('ConnectingImage',true));
	LoadingLabel = UILabel(FindChild('LoadingLabel', true));

	MapVoteClock = UILabel(FindChild('MapVoteClock',true));

	// Find the tab control

	TabControl = UTUITabControl( FindChild('TabControl',true) );

	if ( TabControl != none )
	{

		GameClass = Class<UTGame>( GetWorldInfo().GRI.GameClass);
		if ( GameClass != none && !GameClass.default.bMidGameHasMap )
		{
			TabControl.RemoveTabByTag('MapTab');
		}

		TabControl.OnPageActivated = OnPageActivated;

		if ( GetWorldInfo().NetMode == NM_StandALone || IsConsole() )
		{
			TabControl.RemoveTabByTag('ChatTab');
		}

		if ( GetWorldInfo().NetMode == NM_StandALone)
		{
			TabControl.RemoveTabByTag('FriendsTab');
			TabControl.RemoveTabByTag('MessageTab');
		}
	}

	// Setup initial button bar
	SetupButtonBar();

	// Setup handler for input keys
	OnRawInputKey=HandleInputKey;
	OnPreRenderCallBack = PreRenderCallBack;

	InGamePage = UTUITabPage_InGame(FindChild('GameTab',true));

	VotePage = UTUITabPage_VoteTab(FindChild('VoteTab', True));

	// Disable the Vote tab until it is needed (note: the vote tab gets reordered when shown)
	PC = GetUTPlayerOwner(0);

	if (PC == none || PC.VoteRI == none)
		TabControl.RemoveTabByTag('VoteTab');
	else
		RepositionVotePage();
}

function PreRenderCallBack()
{
	local UTPlayerController PC;

	PC = GetUTPlayerOwner(0);

	if (PC != none && PC.VoteRI != none )
	{
		BeginVoting(PC.VoteRI);
	}

	bCloseOnLevelChange = false;

	OnPreRenderCallBack = none;
}


function ActivateTab(name TabTag)
{
	if (TabTag == 'ChatTab' && IsConsole())
	{
		TabTag = 'ScoreTab';
	}

	if ( TabControl != none )
	{
		if ( TabControl.ActivePage.WidgetTag != 'ChatTab' && TabControl.ActivateTabByTag(TabTag) )
		{
			return;
		}
	}
}

/*
function RemoveGameVoteTab()
{
	local WorldInfo WI;
	local UTGameReplicationInfo GRI;

	//Remove the "game" tab if we are in Instant Action
	WI = GetWorldInfo();
	if (WI != none && WI.NetMode == NM_Standalone && InGamePage.GetOwnerTabControl() != None)
	{
		GRI = UTGameReplicationInfo(WI.GRI);
		if (GRI != None && !GRI.bStoryMode) 
		{
			TabControl.RemovePage(InGamePage, 0);
		}
		else
		{
			`log("Didn't remove"@InGamePage.GetOwnerTabControl()@"GRI:"@(GRI != None)@"Story:"@GRI.bStoryMode);
		}
	}
}
*/

/** Function that sets up a buttonbar for this scene, automatically routes the call to the currently selected tab of the scene as well. */
function SetupButtonBar()
{
	local UTGameReplicationInfo GRI;
	local WorldInfo WI;
	local UTPlayerController UTPC;

	if(ButtonBar != none)
	{
	    	WI = GetWorldInfo();
    		GRI = UTGameReplicationInfo(WI.GRI);

		ButtonBar.Clear();

		// Depending on when we are, set the proper button.

		if ( WI != none )
		{
			if ( !WI.IsInSeamlessTravel() )
			{
				if ( bWaitingForReady )
				{
				    ButtonBar.AppendButton("<Strings:UTGameUI.ButtonCallouts.Ready>", ButtonBarBack);
				}
				else
				{
				    ButtonBar.AppendButton("<Strings:UTGameUI.ButtonCallouts.Back>", ButtonBarBack);
				}

				if (WI.NetMode == NM_StandAlone || (GRI != None && GRI.bStoryMode))
				{
					ButtonBar.AppendButton("<Strings:UTGameUI.MidGameMenu.Forfeit>",ButtonBarDisconnect);
				}
				else
				{
					ButtonBar.AppendButton("<Strings:UTGameUI.MidGameMenu.LeaveGame>",ButtonBarDisconnect);
				}

				ButtonBar.AppendButton("<Strings:UTGameUI.ButtonCallouts.ExitGame>",ButtonBarExitGame);

				if (TabControl != None && (!bWaitingForReady || UTUITabPage_InGame(TabControl.ActivePage) != None ||
					UTUITabPage_VoteTab(TabControl.ActivePage) != none))
				{
					// Let the current tab page try to setup the button bar
					UTTabPage(TabControl.ActivePage).SetupButtonBar(ButtonBar);
				}

				UTPC = GetUTPlayerOwner();
				if ( (UTPC != None) && (UTPC.PlayerReplicationInfo != None) && UTPC.PlayerReplicationInfo.bOnlySpectator )
				{
				    ButtonBar.AppendButton("<Strings:UTGameUI.ButtonCallouts.JoinServer>", ButtonBarJoin);
				}
			}
			else
			{
				if (WI.NetMode == NM_StandAlone || (GRI != None && GRI.bStoryMode))
				{
					ButtonBar.AppendButton("<Strings:UTGameUI.MidGameMenu.Forfeit>", ButtonBarDisconnect);
				}
				else
				{
					ButtonBar.AppendButton("<Strings:UTGameUI.MidGameMenu.LeaveGame>", ButtonBarDisconnect);
				}
				ButtonBar.AppendButton("<Strings:UTGameUI.ButtonCallouts.ExitGame>", ButtonBarExitGame);
			}
		}
	}
}


/**
 * Called when a new page is activated.
 *
 * @param	Sender			the tab control that activated the page
 * @param	NewlyActivePage	the page that was just activated
 * @param	PlayerIndex		the index [into the Engine.GamePlayers array] for the player that generated this event.
 */
function OnPageActivated( UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex )
{
	// Anytime the tab page is changed, update the buttonbar.
	SetupButtonBar();
	bOkToAutoClose = false;
}

function UTUIScene_MessageBox GetMessageBoxScene(optional UIScene SceneReference = None)
{
	local UTUIScene_MessageBox Result;

	Result = Super.GetMessageBoxScene(SceneReference);
	if (Result != None)
	{
		Result.bCloseOnLevelChange = bCloseOnLevelChange;
	}
	return Result;
}

/**
 * Back was selected, exit the menu
 * @Param	InButton			The button that selected
 * @Param	InPlayerIndex		Index of the local player that made the selection
 */

function bool ButtonBarBack(UIScreenObject InButton, int InPlayerIndex)
{
	Back();
	return true;
}

function Back()
{
	UTUITabPage_MapTab( FindChild('MapTab',true)).bIgnoreChange=true;
	SceneClient.CloseScene(self);
}

function bool ButtonBarDisconnect(UIScreenObject InButton, int InPlayerIndex)
{
	Disconnect();
	return true;

}

function bool ButtonBarJoin(UIScreenObject InButton, int InPlayerIndex)
{
	local UTPlayerController UTPC;

	UTPC = GetUTPlayerOwner();
	if ( UTPC != None )
	{
		UTPC.BecomeActive();
		SceneClient.CloseScene(self);
	}
	return true;
}

function bool ButtonBarExitGame(UIScreenObject InButton, int InPlayerIndex)
{
	MBScene = GetMessageBoxScene();
	if(MBScene != none)
	{
		TabControl.PlayUIAnimation('FadeOut',,5.0);
		ButtonBar.PlayUIAnimation('FadeOut',,5.0);
		MBScene.DisplayAcceptCancelBox("<Strings:UTGameUI.MessageBox.ExitGame_Message>","<Strings:UTGameUI.Campaign.Confirmation", MB_ExitSelection);
	}

	return true;

}
function MB_ExitSelection(UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)
{
	TabControl.PlayUIAnimation('FadeIn',,5.0);
	ButtonBar.PlayUIAnimation('FadeIn',,5.0);

	if (SelectedOption == 0)
	{
		ConsoleCommand("Quit");
	}
}


function MB_Selection(UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)
{
	local UTPlayerController PC;
	local UISceneClient SC;

	TabControl.PlayUIAnimation('FadeIn',,5.0);
	ButtonBar.PlayUIAnimation('FadeIn',,5.0);

	if (SelectedOption == 0)
	{
		PC = GetUTPlayerOwner();
		SC = GetSceneClient();
		if ( SC != None )
		{
			bReturningToMainMenu = true;
			SC.CloseScene(self);
		}

		PC.QuitToMainMenu();
	}
	MBScene = none;
}


function Disconnect()
{
	MBScene = GetMessageBoxScene();
	if(MBScene != none)
	{
		TabControl.PlayUIAnimation('FadeOut',,5.0);
		ButtonBar.PlayUIAnimation('FadeOut',,5.0);
		MBScene.DisplayAcceptCancelBox("<Strings:UTGameUI.MidGameMenu.ExitMatchWarning>","<Strings:UTGameUI.Campaign.Confirmation", MB_Selection);
	}
}


function bool HandleInputKey( const out InputEventParameters EventParms )
{

	local UTGameUISceneClient UTSceneClient;

	if ( ButtonBar.IsHidden() )
	{
		return true;
	}

	// Don't allow console commands when in seamless travel.

	if (EventParms.EventType == IE_Released)
	{
		if (!bWaitingForReady )
		{
			if (EventParms.InputKeyName == 'XBoxtypeS_B' || EventParms.InputKeyName == 'Escape' || EventParms.InputKeyName == 'XBoxTypeS_Start')
			{
			    UTSceneClient = UTGameUISceneClient(SceneClient);
				if ( UTSceneClient != none && UTSceneClient.IsInSeamlessTravel() )
				{
					return true;
				}

				Back();
				return true;
			}
		}

		if (EventParms.InputKeyName == 'XBoxTypeS_Y')
		{
			Disconnect();
			return true;
		}
	}

	if ( UTTabPage(TabControl.ActivePage) != none )
	{
		return UTTabPage(TabControl.ActivePage).HandleInputKey( EventParms );
	}
	return false;
}

event UpdateVote(UTGameReplicationInfo GRI)
{
	local string s, LeadingMaps;
	local UTVoteReplicationInfo VoteRI;
	local UTPlayerController UTPC;
	local int i, VoteTimeRemaining;

	UTPC = GetUTPlayerOwner();

	if (UTPC != none && UTPC.VoteRI != none && UTPC.VoteRI.bSupportsNewVoting)
		VoteTimeRemaining = GRI.VoteRoundTimeCounter;
	else
		VoteTimeRemaining = GRI.MapVoteTimeRemaining;

	if (UTPC != none && UTPC.VoteRI != none && VoteTimeRemaining != -1)
	{
		VoteRI = UTPC.VoteRI;

		// Disable the mapvote clock when voting is over
		if (!VoteRI.bVotingOver)
		{
			S = "<Strings:UTGameUI.MidGameMenu.VoteTimePrefix>"@VoteTimeRemaining@
				((VoteTimeRemaining > 1) ? "<Strings:UTGameUI.MidGameMenu.VoteTimeSuffixA>" : "<Strings:UTGameUI.MidGameMenu.VoteTimeSuffixA>");
		}


		// Generate the string of leading maps
		if (VoteRI.LeadingMaps.Length > 0)
		{
			for (i=0; i<Min(3, VoteRI.LeadingMaps.Length); ++i)
			{
				if (i > 0)
					LeadingMaps $= "/";

				LeadingMaps $= VotePage.GetMapFriendlyName(VoteRI.LeadingMaps[i]);
			}

			// Have a maximum of 3 maps in the string; use an ellipsis if there are more
			if (VoteRI.LeadingMaps.Length > 3)
				LeadingMaps @= "/...";

			S @= "("$LeadingMaps$")";
		}



		MapVoteClock.SetDataStoreBinding(S);

		if (MapVoteClock.IsHidden())
			MapVoteClock.SetVisibility(true);
	}
	else if (MapVoteClock.IsVisible())
	{
		MapVoteClock.SetVisibility(False);
	}
}

function UpdateVoteMenuLists(UTVoteReplicationInfo VRI, optional bool bUpdateGameLists, optional bool bUpdateMapLists, optional bool bUpdateMutatorLists)
{
	if (VotePage != none)
	{
		if (bUpdateGameLists)
			VotePage.UpdateGameVoteLists(VRI);

		if (bUpdateMapLists)
			VotePage.UpdateMapVoteLists(VRI);

		if (bUpdateMutatorLists)
			VotePage.UpdateMutatorVoteLists(VRI);
	}
}

function ScoreTabKickVoteNotify()
{
	local UTUITabPage_Scoreboard ScoreTab;

	ScoreTab = UTUITabPage_Scoreboard(FindChild('ScoreTab', True));

	if (ScoreTab != none)
		ScoreTab.NotifyKickVoteConfirmed();
}

function BeginVoting(UTVoteReplicationInfo NewVoteRI)
{
	if (VotePage != none)
	{			   
		RepositionVotePage();
		VotePage.BeginVoting(NewVoteRI);
	}
}

function RepositionVotePage()
{
	local int Idx;

	// If the vote tab is not yet being displayed, then add it now (next to the game tab)
	// always after SCORES
	Idx = Max(1, TabControl.FindPageIndexByPageRef(InGamePage) + 1);

	if (TabControl.GetPageAtIndex(Idx) != VotePage)
	{
		// If the page is already being displayed, but not at the correct index, then remove it first
		if (TabControl.FindPageIndexByPageRef(VotePage) != INDEX_None)
			TabControl.RemovePage(VotePage, 0);

		TabControl.InsertPage(VotePage, 0, Idx, false);
	}
}

/**
 * Parse the scrollback and create a string out of it
 */
function string ParseScrollback(const out array<string> Scrollback)
{
	local int i,Start;
	local string s, Result;

	Result = "";

	Start = (Scrollback.Length < 75) ? 0 : (Scrollback.Length - 75);
	for (i=Start;i<Scrollback.Length;i++)
	{
		if ( (Left(Scrollback[i],7) ~= ">>> Say") || (Left(Scrollback[i],11) ~= ">>> TeamSay") )
		{
			continue;
		}
		else
		{
			s = Repl(Scrollback[i],">","");
			s = Repl(S,"<","");

			Result $= s $ " \n ";
		}
	}

	return Result;
}

/**
 * Reset will set the bWaitingForReady flag and reset the button bar
 */
function Reset()
{
	local UTUITabPage_InGame InGameTab;

	bOkToAutoClose = true;

	bWaitingForReady = true;
	InGameTab = UTUITabPage_InGame( FindChild('GameTab',true));
	InGameTab.Reset(GetWorldInfo());
	SetupButtonBar();
}

event BeginLoading()
{
	local rotator r;

	if ( MBScene != none )
	{
		MBScene.CloseScene(self);
	}

	bLoading = true;
	LoadingPanel.SetVisibility(true);
	LoadingRotator.RotateWidget(r,false);
	SetupButtonBar();
}

event TickLoading(float DeltaTime)
{
	local Player PlayerRef;
	local string LabelText;
	local bool bIsDownloading;
	local int DownloadPercent, DownloadCount;

	if (LoadingLabel != none)
	{
		PlayerRef = GetPlayerOwner();

		if (PlayerRef != none)
		{
			bIsDownloading = PlayerRef.IsDownloading();

			if (bIsDownloading)
			{
				LabelText = Localize("MidGameMenu", "DownloadText", "UTGameUI");

				DownloadPercent = PlayerRef.GetDownloadStatus();
				DownloadCount = PlayerRef.GetDownloadListInfo();
				LabelText = Repl(Repl(LabelText, "`p", DownloadPercent), "`c", DownloadCount);

				LoadingLabel.SetDataStoreBinding(LabelText);
				bWasDownloading = True;
			}
			else if (bWasDownloading)
			{
				LoadingLabel.SetDataStoreBinding("<Strings:UTGameUI.Generic.Loading>");
				bWasDownloading = False;
			}
		}
	}
}

event EndLoading()
{
	if (VotePage != none)
		VotePage.ResetVoteLists();

	bLoading = false;
	bWasDownloading = False;
	LoadingPanel.SetVisibility(false);
	LoadingLabel.SetDataStoreBinding("<Strings:UTGameUI.Generic.Loading>");
	ButtonBar.SetVisibility(true);
	SetupButtonBar();
}

defaultproperties
{
   bDisplayCursor=True
   bRenderParentScenes=False
   bAlwaysRenderScene=True
   bSaveSceneValuesOnClose=False
   bDisableWorldRendering=True
   SceneRenderMode=SPLITRENDER_Fullscreen
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIScene_Hud:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIScene_Hud:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIScene_MidGameMenu"
   ObjectArchetype=UTUIScene_Hud'UTGame.Default__UTUIScene_Hud'
}