UE3:UTUIFrontEnd_MainMenu (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_BasicMenu >> UTUIFrontEnd_MainMenu

Package: 

UTGame

This class in other games:

UDK

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

Main Menu Scene for UT3.

Constants

MAINMENU_OPTION_CAMPAIGN

Value: 0

MAINMENU_OPTION_INSTANTACTION

Value: 1

MAINMENU_OPTION_MULTIPLAYER

Value: 2

MAINMENU_OPTION_COMMUNITY

Value: 3

MAINMENU_OPTION_SETTINGS

Value: 4

MAINMENU_OPTION_EXIT

Value: 5

Properties

bLogoutWasSuccessful

Type: bool

Modifiers: transient

Whether or not the logout was successful.

CampaignContinueScene

Type: string

If there is an existing campaign go here

Default value: "UI_Scenes_Campaign.Scenes.CampNewOrContinue"

CampaignStartScene

Type: string

If there isn't an existing campaign go here

Default value: "UI_Scenes_Campaign.Scenes.CampOptions"

CDKeyScene

Type: string

Reference to the CDKey screen.

Default value: "UI_Scenes_FrontEnd.CDKey"

CommunityScene

Type: string

Reference to the community scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.Community"

DemoSellScene

Type: string

Default value: "UI_Scenes_FrontEnd.Scenes.DemoSell"

InstantActionScene

Type: string

Reference to the instant action scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.InstantAction"

LoginScreenScene

Type: string

Reference to the Login screen.

Default value: "UI_Scenes_ChrisBLayout.Scenes.LoginScreen"

LogoutPlayerIndex

Type: int

Modifiers: transient

Index of the player that is currently logging out.

MessageBoxReference

Type: UTUIScene_MessageBox

Modifiers: transient

Reference to the modal message box.

MultiplayerScene

Type: string

Reference to the multiplayer scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.Multiplayer"

SettingsScene

Type: string

Reference to the settings scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.Settings"

Default values

Property	Value
bSupportBackButton	False
VersionFont	MultiFont'UI_Fonts_Final.Menus.Fonts_Positec'

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd_BasicMenu.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

Scene activated event, sets up the title for the scene.

Other instance functions

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd_BasicMenu.HandleInputKey

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.

Parameters:

• EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

MinSpecMessageClosed

function MinSpecMessageClosed ()

OnButtonBar_Login

function bool OnButtonBar_Login (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Logout

function bool OnButtonBar_Logout (UIScreenObject InButton, int InPlayerIndex)

OnLogin

function OnLogin ()

Calls the platform specific login function.

OnLogin360

function OnLogin360 ()

Login handler for the 360.

OnLoginPC

function OnLoginPC ()

Login handler for the PC.

OnLoginPC_Logout_Confirm

function OnLoginPC_Logout_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Confirmation for the login game dialog.

OnLoginScreenOpened

function OnLoginScreenOpened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the login screen has opened.

OnLogout

function OnLogout (int PlayerIndex)

Tries to logout the currently logged in player.

OnLogout_Confirm

function OnLogout_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Confirmation for the exit game dialog.

OnLogoutCompleted

function OnLogoutCompleted (bool bWasSuccessful)

Delegate used in notifying the UI/game that the manual logout completed

Parameters:

• bWasSuccessful - whether the async call completed properly or not

OnLogoutCompleted_LogoutMessageClosed

function OnLogoutCompleted_LogoutMessageClosed ()

Called after the logging out message has disappeared.

OnMainRegion_Show_UIAnimEnd

function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Callback for when the show animation has completed for this scene.

OnMenu_ExitGame

function OnMenu_ExitGame ()

Exit game option selected.

OnMenu_ExitGame_Confirm

function OnMenu_ExitGame_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Confirmation for the exit game dialog.

OnMultiplayerScreenOpened

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

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd_BasicMenu.SetupButtonBar

Setup the scene's buttonbar.

StartCampaign

function StartCampaign (int PlayerIndex)

Starts the Campaign.

VerifyMinSpecs

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.