Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTGame.UTUIFrontEnd_MainMenu

Extends
UTUIFrontEnd_BasicMenu

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Main Menu Scene for UT3.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd
               |   
               +-- UTGame.UTUIFrontEnd_BasicMenu
                  |   
                  +-- UTGame.UTUIFrontEnd_MainMenu

Constants Summary
MAINMENU_OPTION_CAMPAIGN=0
MAINMENU_OPTION_COMMUNITY=3
MAINMENU_OPTION_EXIT=5
MAINMENU_OPTION_INSTANTACTION=1
MAINMENU_OPTION_MULTIPLAYER=2
MAINMENU_OPTION_SETTINGS=4

Variables Summary
boolbLogoutWasSuccessful
stringCampaignContinueScene
stringCampaignStartScene
stringCDKeyScene
stringCommunityScene
stringDemoSellScene
stringInstantActionScene
stringLoginScreenScene
intLogoutPlayerIndex
UTUIScene_MessageBoxMessageBoxReference
stringMultiplayerScene
stringSettingsScene
Inherited Variables from UTGame.UTUIFrontEnd_BasicMenu
bSupportBackButton, DescriptionLabel, MenuList
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport

Functions Summary
functionbool HandleInputKey (const out InputEventParameters EventParms ))
function MinSpecMessageClosed ()))
functionbool OnButtonBar_Login (UIScreenObject InButton, int InPlayerIndex))
functionbool OnButtonBar_Logout (UIScreenObject InButton, int InPlayerIndex))
function OnLogin ()))
function OnLogin360 ()))
function OnLoginPC ()))
function OnLoginPC_Logout_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
function OnLoginScreenOpened (UIScene OpenedScene, bool bInitialActivation))
function OnLogout (int PlayerIndex))
function OnLogoutCompleted (bool bWasSuccessful))
function OnLogoutCompleted_LogoutMessageClosed ()))
function OnLogout_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
function OnMenu_ExitGame ()))
function OnMenu_ExitGame_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
function OnMultiplayerScreenOpened (UIScene OpenedScene, bool bInitialActivation))
function OnSelectItem (int PlayerIndex=0))
event PostInitialize ()))
event SceneActivated (bool bInitialActivation))
function SetupButtonBar ()))
function StartCampaign (int PlayerIndex))
function VerifyMinSpecs ()))
Inherited Functions from UTGame.UTUIFrontEnd_BasicMenu
HandleInputKey, OnBack, OnButtonBar_Back, OnButtonBar_Select, OnMenu_SubmitSelection, OnMenu_ValueChanged, OnSelectItem, PostInitialize, SetupButtonBar
Inherited Functions from UTGame.UTUIFrontEnd
BeginHideAnimation, BeginImportMod, BeginInstallPS3, BeginShowAnimation, CancelInstallPS3, CheckForFrontEndError, ChildSceneOpened, GetTitleLabel, HandleInputKey, ImportMod, InstallPS3, OnCancelInstallPS3, OnCancelMessageClosed, OnImportModFinished, OnInstallMessageClosed, OnLoginError_Confirm, OnMainRegion_Show_UIAnimEnd, OnPageActivated, OnRetryPasswordDialog_Closed, OnTabPage_Hide_UIAnimEnd, OnTabPage_Show_UIAnimEnd, PostInitialize, PromptForPassword, SavePassword, SceneActivated, SetTitle, SetupButtonBar, UpdateModState, UpdatePS3InstallState


Constants Detail

MAINMENU_OPTION_CAMPAIGN Source code

const MAINMENU_OPTION_CAMPAIGN = 0;

MAINMENU_OPTION_COMMUNITY Source code

const MAINMENU_OPTION_COMMUNITY = 3;

MAINMENU_OPTION_EXIT Source code

const MAINMENU_OPTION_EXIT = 5;

MAINMENU_OPTION_INSTANTACTION Source code

const MAINMENU_OPTION_INSTANTACTION = 1;

MAINMENU_OPTION_MULTIPLAYER Source code

const MAINMENU_OPTION_MULTIPLAYER = 2;

MAINMENU_OPTION_SETTINGS Source code

const MAINMENU_OPTION_SETTINGS = 4;


Variables Detail

bLogoutWasSuccessful Source code

var transient bool bLogoutWasSuccessful;
Whether or not the logout was successful.

CampaignContinueScene Source code

var string CampaignContinueScene;
If there is an existing campaign go here

CampaignStartScene Source code

var string CampaignStartScene;
If there isn't an existing campaign go here

CDKeyScene Source code

var string CDKeyScene;
Reference to the CDKey screen.

CommunityScene Source code

var string CommunityScene;
Reference to the community scene.

DemoSellScene Source code

var string DemoSellScene;

InstantActionScene Source code

var string InstantActionScene;
Reference to the instant action scene.

LoginScreenScene Source code

var string LoginScreenScene;
Reference to the Login screen.

LogoutPlayerIndex Source code

var transient int LogoutPlayerIndex;
Index of the player that is currently logging out.

MessageBoxReference Source code

var transient UTUIScene_MessageBox MessageBoxReference;
Reference to the modal message box.

MultiplayerScene Source code

var string MultiplayerScene;
Reference to the multiplayer scene.

SettingsScene Source code

var string SettingsScene;
Reference to the settings scene.


Functions Detail

HandleInputKey Source code

function bool HandleInputKey ( const out InputEventParameters EventParms ) )
Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

MinSpecMessageClosed Source code

function MinSpecMessageClosed ( ) )

OnButtonBar_Login Source code

function bool OnButtonBar_Login ( UIScreenObject InButton, int InPlayerIndex) )
Buttonbar Callbacks.

OnButtonBar_Logout Source code

function bool OnButtonBar_Logout ( UIScreenObject InButton, int InPlayerIndex) )

OnLogin Source code

function OnLogin ( ) )
Calls the platform specific login function.

OnLogin360 Source code

function OnLogin360 ( ) )
Login handler for the 360.

OnLoginPC Source code

function OnLoginPC ( ) )
Login handler for the PC.

OnLoginPC_Logout_Confirm Source code

function OnLoginPC_Logout_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the login game dialog.

OnLoginScreenOpened Source code

function OnLoginScreenOpened ( UIScene OpenedScene, bool bInitialActivation) )
Callback for when the login screen has opened.

OnLogout Source code

function OnLogout ( int PlayerIndex) )
Tries to logout the currently logged in player.

OnLogoutCompleted Source code

function OnLogoutCompleted ( bool bWasSuccessful) )
Delegate used in notifying the UI/game that the manual logout completed
@param bWasSuccessful whether the async call completed properly or not

OnLogoutCompleted_LogoutMessageClosed Source code

function OnLogoutCompleted_LogoutMessageClosed ( ) )
Called after the logging out message has disappeared.

OnLogout_Confirm Source code

function OnLogout_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the exit game dialog.

OnMainRegion_Show_UIAnimEnd Source code

function OnMainRegion_Show_UIAnimEnd ( UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq) )
Callback for when the show animation has completed for this scene.

OnMenu_ExitGame Source code

function OnMenu_ExitGame ( ) )
Exit game option selected.

OnMenu_ExitGame_Confirm Source code

function OnMenu_ExitGame_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the exit game dialog.

OnMultiplayerScreenOpened Source code

function OnMultiplayerScreenOpened ( UIScene OpenedScene, bool bInitialActivation) )
Callback for when the multiplayer screen has opened (only called when returning to the server browser after a disconnect).

OnSelectItem Source code

function OnSelectItem ( int PlayerIndex=0) )
Executes a action based on the currently selected menu item.

PostInitialize Source code

event PostInitialize ( ) )
PostInitialize event - Sets delegates for the scene.

SceneActivated Source code

event SceneActivated ( bool bInitialActivation) )

SetupButtonBar Source code

function SetupButtonBar ( ) )
Setup the scene's buttonbar.

StartCampaign Source code

function StartCampaign ( int PlayerIndex) )
Starts the Campaign.

VerifyMinSpecs Source code

function VerifyMinSpecs ( ) )
Checks whether user's machine meets the minimum required specs to play the game, and if not displays a warning message to the user which points them to the release notes and [possibly] tweak guide.


Defaultproperties

defaultproperties
{
   CampaignStartScene="UI_Scenes_Campaign.Scenes.CampOptions"
   CampaignContinueScene="UI_Scenes_Campaign.Scenes.CampNewOrContinue"
   InstantActionScene="UI_Scenes_ChrisBLayout.Scenes.InstantAction"
   MultiplayerScene="UI_Scenes_ChrisBLayout.Scenes.Multiplayer"
   CommunityScene="UI_Scenes_ChrisBLayout.Scenes.Community"
   SettingsScene="UI_Scenes_ChrisBLayout.Scenes.Settings"
   LoginScreenScene="UI_Scenes_ChrisBLayout.Scenes.LoginScreen"
   CDKeyScene="UI_Scenes_FrontEnd.CDKey"
   DemoSellScene="UI_Scenes_FrontEnd.Scenes.DemoSell"
   bSupportBackButton=False
   VersionFont=MultiFont'UI_Fonts_Final.Menus.Fonts_Positec'
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_MainMenu"
   ObjectArchetype=UTUIFrontEnd_BasicMenu'UTGame.Default__UTUIFrontEnd_BasicMenu'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:58.839 - Created with UnCodeX