Cogito, ergo sum

UE3:UTUIFrontEnd_MainMenu (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

MAINMENU_OPTION_CAMPAIGN[edit]

Value: 0


MAINMENU_OPTION_INSTANTACTION[edit]

Value: 1


MAINMENU_OPTION_MULTIPLAYER[edit]

Value: 2


MAINMENU_OPTION_COMMUNITY[edit]

Value: 3


MAINMENU_OPTION_SETTINGS[edit]

Value: 4


MAINMENU_OPTION_EXIT[edit]

Value: 5


Properties[edit]

bLogoutWasSuccessful[edit]

Type: bool

Modifiers: transient

Whether or not the logout was successful.

CampaignContinueScene[edit]

Type: string

If there is an existing campaign go here

Default value: "UI_Scenes_Campaign.Scenes.CampNewOrContinue"

CampaignStartScene[edit]

Type: string

If there isn't an existing campaign go here

Default value: "UI_Scenes_Campaign.Scenes.CampOptions"

CDKeyScene[edit]

Type: string

Reference to the CDKey screen.

Default value: "UI_Scenes_FrontEnd.CDKey"

CommunityScene[edit]

Type: string

Reference to the community scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.Community"

DemoSellScene[edit]

Type: string


Default value: "UI_Scenes_FrontEnd.Scenes.DemoSell"

InstantActionScene[edit]

Type: string

Reference to the instant action scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.InstantAction"

LoginScreenScene[edit]

Type: string

Reference to the Login screen.

Default value: "UI_Scenes_ChrisBLayout.Scenes.LoginScreen"

LogoutPlayerIndex[edit]

Type: int

Modifiers: transient

Index of the player that is currently logging out.

MessageBoxReference[edit]

Type: UTUIScene_MessageBox

Modifiers: transient

Reference to the modal message box.

MultiplayerScene[edit]

Type: string

Reference to the multiplayer scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.Multiplayer"

SettingsScene[edit]

Type: string

Reference to the settings scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.Settings"

Default values[edit]

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

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd_BasicMenu.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated[edit]

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

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

Other instance functions[edit]

HandleInputKey[edit]

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[edit]

function MinSpecMessageClosed ()


OnButtonBar_Login[edit]

function bool OnButtonBar_Login (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Logout[edit]

function bool OnButtonBar_Logout (UIScreenObject InButton, int InPlayerIndex)


OnLogin[edit]

function OnLogin ()

Calls the platform specific login function.

OnLogin360[edit]

function OnLogin360 ()

Login handler for the 360.

OnLoginPC[edit]

function OnLoginPC ()

Login handler for the PC.

OnLoginPC_Logout_Confirm[edit]

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

Confirmation for the login game dialog.

OnLoginScreenOpened[edit]

function OnLoginScreenOpened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the login screen has opened.

OnLogout[edit]

function OnLogout (int PlayerIndex)

Tries to logout the currently logged in player.

OnLogout_Confirm[edit]

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

Confirmation for the exit game dialog.

OnLogoutCompleted[edit]

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[edit]

function OnLogoutCompleted_LogoutMessageClosed ()

Called after the logging out message has disappeared.

OnMainRegion_Show_UIAnimEnd[edit]

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[edit]

function OnMenu_ExitGame ()

Exit game option selected.

OnMenu_ExitGame_Confirm[edit]

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

Confirmation for the exit game dialog.

OnMultiplayerScreenOpened[edit]

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[edit]

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd_BasicMenu.SetupButtonBar

Setup the scene's buttonbar.

StartCampaign[edit]

function StartCampaign (int PlayerIndex)

Starts the Campaign.

VerifyMinSpecs[edit]

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.