UE3:UTUIFrontEnd_LaunchGame (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_LaunchGame

Package: 

UTGame

Direct subclasses:

UTUIFrontEnd_HostGame, UTUIFrontEnd_InstantAction

This class in other games:

UDK

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

Launch game scene for UT3, contains functionality common to instant action and host game flows.

Properties

bForceRefreshOptionList

Type: bool

Modifiers: transient

Whether or not the option list should be refreshed.

bFullyInitialized

Type: bool

Modifiers: transient

Whether or not we're fully initialized yet.

GameMode

Type: string

Modifiers: transient

GameModeTab

Type: UTUITabPage_GameModeSelection

Modifiers: transient

References to the tab control and pages.

GameSettingsTab

Type: UTUITabPage_Options

Modifiers: transient

MapName

Type: string

Modifiers: transient

Current match settings, used to launch the game. .

MapTab

Type: UTUITabPage_MapSelection

Modifiers: transient

SettingsDataStore

Type: UIDataStore_OnlineGameSettings

Modifiers: transient

Reference to the settings datastore that we will use to create the game.

SettingsProfileName

Type: string

The name that this class uses to store the current game profiles settings (for reloading previous menu option settings)

StringListDataStore

Type: UTUIDataStore_StringList

Modifiers: transient

Reference to the stringlist datastore that we will use to create the game.

Default values

Property	Value
bMenuLevelRestoresScene	True

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

Scene activation event, always sets focus to current tab page if activating the page for a second time.

Other instance functions

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.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.

OnAcceptGameSettings

function OnAcceptGameSettings (UIScreenObject InObject, int PlayerIndex)

Callback for when the user has accepted the game settings.

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_Next

function bool OnButtonBar_Next (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_StartGame

function bool OnButtonBar_StartGame (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnGameModeSelected

function OnGameModeSelected (string InGameMode, string InDefaultMap, string GameSettingsClass, bool bSelectionSubmitted)

Callback for when the gamemode changes on the game mode selection tab.

OnMapSelected

function OnMapSelected ()

Callback for when the user has selected the map.

OnPageActivated

function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)

Overrides: UTUIFrontEnd.OnPageActivated

Called when a new page is activated.

Parameters:

• Sender - the tab control that activated the page
• NewlyActivePage - the page that was just activated
• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this event.

OnStartGame

function OnStartGame ()

Starts the game.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the button bar for the scene.

ShowNextTab

function ShowNextTab ()

Shows the next tab page, if we are at the last tab, then we start the game.

ShowPrevTab

function ShowPrevTab ()

Shows the previous tab page, if we are at the first tab, then we close the scene.