UTGame.UTUIScene_OnlineToast

/**
 * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
 *
 * Online toast message scene.
 */
class UTUIScene_OnlineToast extends UTUIScene
	native(UI);

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

/** Reference to the message label for the toast. */
var transient UILabel MessageLabel;

/** The time the toast message was displayed at. */
var transient float	ShowStartTime;

/** Whether or not this toast is in the showing or hiding state. */
var transient bool bFullyVisible;

/** Amount of time to display the toast for. */
var() float ToastDuration;

event PostInitialize()
{
	Super.PostInitialize();

	// Store widget references
	MessageLabel = UILabel(FindChild('lblMessage',true));
}

/** Sets the current message for this scene. */
function SetMessage(string Message)
{
	MessageLabel.SetDataStoreBinding(Message);
	ShowStartTime = GetWorldInfo().RealTimeSeconds;
	bFullyVisible = true;
}

/** Called when the toast is complete and ready to be hidden. */
event FinishToast()
{
	bFullyVisible = false;
	CloseScene(self);
}

/**
 * Starts the show animation for the scene.
 *
 * @param	bInitialActivation	TRUE if the scene is being opened; FALSE if the another scene was closed causing this one to become the
 *								topmost scene.
 * @param	bBypassAnimation	TRUE to force all animations to their last frame, effectively bypassing animations.  This can
 *								be necessary for e.g. scenes which start out off-screen or something.
 *
 *
 * @return TRUE if there's animation for this scene, FALSE otherwise.
 */
function bool BeginShowAnimation(bool bInitialActivation=true, bool bBypassAnimation=false)
{
	local UIObject MainRegion;

	MainRegion = FindChild('imgBG', true);
	MainRegion.StopUIAnimation('OnlineToastHide');
	MainRegion.PlayUIAnimation('OnlineToastShow',,,,bBypassAnimation ? 1.0 : 0.0);

	return true;
}

/**
 * Starts the exit animation for the scene.
 *
 * @return TRUE if there's animation for this scene, FALSE otherwise.
 */
function bool BeginHideAnimation(bool bClosingScene=false)
{
	local UIObject MainRegion;

	MainRegion = FindChild('imgBG', true);
	MainRegion.OnUIAnimEnd = OnAnimToastHideEnded;
	MainRegion.PlayUIAnimation('OnlineToastHide');

	return true;
}

/** Callback for when the hide animation has ended. */
function OnAnimToastHideEnded(UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)
{
	AnimTarget.OnUIAnimEnd = None;
	OnHideAnimationEnded();
}

defaultproperties
{
   ToastDuration=5.000000
   bIgnoreAxisInput=True
   bRenderParentScenes=True
   bAlwaysRenderScene=True
   bPauseGameWhileActive=False
   bFlushPlayerInput=False
   DefaultContextMenuClass=Class'Engine.UIContextMenu'
   SceneInputMode=INPUTMODE_None
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIScene:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIScene:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIScene_OnlineToast"
   ObjectArchetype=UTUIScene'UTGame.Default__UTUIScene'
}