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

UTGame.UTUIFrontEnd_LaunchGame

Extends
UTUIFrontEnd
Modifiers
abstract

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Launch game scene for UT3, contains functionality common to instant action and host game flows.

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

Direct Known Subclasses:

UTUIFrontEnd_HostGame, UTUIFrontEnd_InstantAction

Constants Summary
Inherited Contants from UTGame.UTUIScene
CONTEXT_ALLOWKEYBOARD, CONTEXT_ALLOWKEYBOARD_ANY, CONTEXT_ALLOWKEYBOARD_NO, CONTEXT_ALLOWKEYBOARD_YES, CONTEXT_BOTSKILL, CONTEXT_BOTSKILL_ADEPT, CONTEXT_BOTSKILL_AUTOADJUSTSKILL, CONTEXT_BOTSKILL_AVERAGE, CONTEXT_BOTSKILL_EXPERIENCED, CONTEXT_BOTSKILL_GODLIKE, CONTEXT_BOTSKILL_INHUMAN, CONTEXT_BOTSKILL_MASTERFUL, CONTEXT_BOTSKILL_NOVICE, CONTEXT_BOTSKILL_SKILLED, CONTEXT_CAMPAIGN, CONTEXT_CAMPAIGN_NO, CONTEXT_CAMPAIGN_YES, CONTEXT_DEDICATEDSERVER, CONTEXT_DEDICATEDSERVER_NO, CONTEXT_DEDICATEDSERVER_YES, CONTEXT_EMPTYSERVER, CONTEXT_EMPTYSERVER_NO, CONTEXT_EMPTYSERVER_YES, CONTEXT_FORCERESPAWN, CONTEXT_FORCERESPAWN_NO, CONTEXT_FORCERESPAWN_YES, CONTEXT_FULLSERVER, CONTEXT_FULLSERVER_NO, CONTEXT_FULLSERVER_YES, CONTEXT_GAME_MODE, CONTEXT_GAME_MODE_BETRAYAL, CONTEXT_GAME_MODE_CAMPAIGN, CONTEXT_GAME_MODE_CTF, CONTEXT_GAME_MODE_CUSTOM, CONTEXT_GAME_MODE_DM, CONTEXT_GAME_MODE_DUEL, CONTEXT_GAME_MODE_GREED, CONTEXT_GAME_MODE_TDM, CONTEXT_GAME_MODE_VCTF, CONTEXT_GAME_MODE_WAR, CONTEXT_GOALSCORE_10, CONTEXT_GOALSCORE_15, CONTEXT_GOALSCORE_20, CONTEXT_GOALSCORE_30, CONTEXT_GOALSCORE_5, CONTEXT_LOCKEDSERVER, CONTEXT_LOCKEDSERVER_NO, CONTEXT_LOCKEDSERVER_YES, CONTEXT_MAPNAME, CONTEXT_MAPNAME_ARSENAL, CONTEXT_MAPNAME_AVALANCHE, CONTEXT_MAPNAME_BIOHAZARD, CONTEXT_MAPNAME_CARBON_FIRE, CONTEXT_MAPNAME_COLDHARBOR, CONTEXT_MAPNAME_CONFRONTATION, CONTEXT_MAPNAME_CONTAINMENT, CONTEXT_MAPNAME_CONTAINMENTSP, CONTEXT_MAPNAME_CORET, CONTEXT_MAPNAME_CORRUPTION, CONTEXT_MAPNAME_CUSTOM, CONTEXT_MAPNAME_DARKMATCH, CONTEXT_MAPNAME_DECK, CONTEXT_MAPNAME_DEFIANCE, CONTEXT_MAPNAME_DEIMOS, CONTEXT_MAPNAME_DIESEL, CONTEXT_MAPNAME_DOWNTOWN, CONTEXT_MAPNAME_DOWNTOWNNECRIS, CONTEXT_MAPNAME_DUSK, CONTEXT_MAPNAME_EDENINC, CONTEXT_MAPNAME_FACINGWORLDS, CONTEXT_MAPNAME_FEARLESS, CONTEXT_MAPNAME_FLOODGATE, CONTEXT_MAPNAME_GATEWAY, CONTEXT_MAPNAME_HEAT_RAY, CONTEXT_MAPNAME_HOSTILE, CONTEXT_MAPNAME_HYDROSIS, CONTEXT_MAPNAME_ISLANDER, CONTEXT_MAPNAME_ISLANDERNECRIS, CONTEXT_MAPNAME_KARGO, CONTEXT_MAPNAME_KBARGE, CONTEXT_MAPNAME_LOSTCAUSE, CONTEXT_MAPNAME_MARKET_DISTRICT, CONTEXT_MAPNAME_MISSION_SELECTION, CONTEXT_MAPNAME_MORBIAS, CONTEXT_MAPNAME_MORBID, CONTEXT_MAPNAME_NANOBLACK, CONTEXT_MAPNAME_NECROPOLIS, CONTEXT_MAPNAME_OCEANRELIC, CONTEXT_MAPNAME_OMICRON_DAWN, CONTEXT_MAPNAME_ONYX_COAST, CONTEXT_MAPNAME_POWER_SURGE, CONTEXT_MAPNAME_RAILS, CONTEXT_MAPNAME_REFLECTION, CONTEXT_MAPNAME_RISING_SUN, CONTEXT_MAPNAME_SANCTUARY, CONTEXT_MAPNAME_SANDSTORM, CONTEXT_MAPNAME_SEARCHLIGHT, CONTEXT_MAPNAME_SENTINEL, CONTEXT_MAPNAME_SERENITY, CONTEXT_MAPNAME_SERENITYNECRIS, CONTEXT_MAPNAME_SHAFT, CONTEXT_MAPNAME_SHANGRILA, CONTEXT_MAPNAME_SINKHOLE, CONTEXT_MAPNAME_STRANDED, CONTEXT_MAPNAME_STRIDENT, CONTEXT_MAPNAME_SUSPENSE, CONTEXT_MAPNAME_SUSPENSE_NECRIS, CONTEXT_MAPNAME_TANK_CROSSING, CONTEXT_MAPNAME_TORLAN, CONTEXT_MAPNAME_TORLANLEVIATHAN, CONTEXT_MAPNAME_TORLANNECRIS, CONTEXT_MAPNAME_TURBINE, CONTEXT_MAPNAME_VERTEBRAE, CONTEXT_NUMBOTS_0, CONTEXT_NUMBOTS_1, CONTEXT_NUMBOTS_2, CONTEXT_NUMBOTS_3, CONTEXT_NUMBOTS_4, CONTEXT_NUMBOTS_5, CONTEXT_NUMBOTS_6, CONTEXT_NUMBOTS_7, CONTEXT_NUMBOTS_8, CONTEXT_PRESENCE_MENUPRESENCE, CONTEXT_PURESERVER, CONTEXT_PURESERVER_ANY, CONTEXT_PURESERVER_NO, CONTEXT_PURESERVER_YES, CONTEXT_TIMELIMIT_10, CONTEXT_TIMELIMIT_15, CONTEXT_TIMELIMIT_20, CONTEXT_TIMELIMIT_30, CONTEXT_TIMELIMIT_5, CONTEXT_VSBOTS, CONTEXT_VSBOTS_1_TO_1, CONTEXT_VSBOTS_1_TO_2, CONTEXT_VSBOTS_2_TO_1, CONTEXT_VSBOTS_3_TO_1, CONTEXT_VSBOTS_3_TO_2, CONTEXT_VSBOTS_4_TO_1, CONTEXT_VSBOTS_NONE, GS_CDKEY_PART_MAXLENGTH, GS_EMAIL_MAXLENGTH, GS_MESSAGE_MAXLENGTH, GS_PASSWORD_MAXLENGTH, GS_USERNAME_MAXLENGTH, PROPERTY_CUSTOMGAMEMODE, PROPERTY_CUSTOMMAPNAME, PROPERTY_CUSTOMMUTATORS, PROPERTY_CUSTOMMUTCLASSES, PROPERTY_EPICMUTATORS, PROPERTY_GOALSCORE, PROPERTY_LEADERBOARDRATING, PROPERTY_NUMBOTS, PROPERTY_NUMBOTSIA, PROPERTY_SERVERDESCRIPTION, PROPERTY_STEAMID, PROPERTY_STEAMVAC, PROPERTY_TIMELIMIT, QUERY_BETRAYAL, QUERY_CAMPAIGN, QUERY_CTF, QUERY_DM, QUERY_DUEL, QUERY_GREED, QUERY_TDM, QUERY_VCTF, QUERY_WAR, STATS_VIEW_DM_PLAYER_ALLTIME, STATS_VIEW_DM_RANKED_ALLTIME, STATS_VIEW_DM_VEHICLES_ALLTIME, STATS_VIEW_DM_VEHICLES_RANKED_ALLTIME, STATS_VIEW_DM_VEHICLEWEAPONS_ALLTIME, STATS_VIEW_DM_VEHICLEWEAPONS_RANKED_ALLTIME, STATS_VIEW_DM_WEAPONS_ALLTIME, STATS_VIEW_DM_WEAPONS_RANKED_ALLTIME

Variables Summary
boolbForceRefreshOptionList
boolbFullyInitialized
stringGameMode
UTUITabPage_GameModeSelectionGameModeTab
UTUITabPage_OptionsGameSettingsTab
stringMapName
UTUITabPage_MapSelectionMapTab
UIDataStore_OnlineGameSettingsSettingsDataStore
stringSettingsProfileName
UTUIDataStore_StringListStringListDataStore
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText
Inherited Variables from UTGame.UTUIScene
bEditorRealTimePreview, bHidingScene, bIgnoreAxisInput, bShowingScene, bSkipPendingCloseSceneNotify, InputBoxScene, MessageBoxScene, OnlineToastScene, PendingCloseScene, PendingOpenScene, PlayerCardScene

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport
Inherited Enumerations from UTGame.UTUIScene
EUTBotTeam, EUTRecordDemo

Functions Summary
functionbool HandleInputKey (const out InputEventParameters EventParms ))
function OnAcceptGameSettings (UIScreenObject InObject, int PlayerIndex))
functionbool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_Next (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_StartGame (UIScreenObject InButton, int PlayerIndex))
function OnGameModeSelected (string InGameMode, string InDefaultMap, string GameSettingsClass, bool bSelectionSubmitted))
function OnMapSelected ()))
function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex ))
function OnStartGame ()
event PostInitialize ()))
event SceneActivated (bool bInitialActivation))
function SetupButtonBar ()))
function ShowNextTab ()))
function ShowPrevTab ()))
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
Inherited Functions from UTGame.UTUIScene
ActivateLevelEvent, AnimEnd, BeginHideAnimation, BeginShowAnimation, CheckCommunicationPrivilegeAndError, CheckContentPrivilegeAndError, CheckForAutoLogin, CheckLinkConnectionAndError, CheckLoginAndError, CheckNatTypeAndDisplayError, CheckOnlinePrivilegeAndError, CloseScene, ConditionallyCheckNumControllers, ConditionallyStartSplitscreen, ConsoleCommand, DeleteDemo, DisplayMessageBox, FindDataStore, FinishCloseScene, FinishOpenScene, GenerateDemoFileName, GetAccountInterface, GetBotTeamNameFromIndex, GetCommonOptionsURL, GetCurrentAudioDevice, GetGameInterface, GetInputBoxScene, GetMessageBoxScene, GetPawnOwner, GetPlayerControllerId, GetPlayerIndex, GetPlayerInterface, GetPlayerInterfaceEx, GetPlayerName, GetPlayerProfile, GetPlayerProfileFromPC, GetPossibleAudioDevices, GetPossibleScreenResolutions, GetPRIOwner, GetUTInteraction, GetUTPlayerOwner, GetWorldInfo, HideOnlineToast, IsBelowMinSpecs, IsControllerInput, IsGame, NotifyChildGameSessionEnded, NotifyGameSessionEnded, OnAnimationFinished, OnCurrentScene_HideAnimationEnded, OnLoginError_Confirm, OnLoginUI_LoginChange, OnLoginUI_LoginFailed, OnPendingCloseScene_HideAnimationEnded, OpenCmdLineURL, OpenScene, OpenSceneByName, PlaySound, SavePlayerProfile, SetAudioDeviceToUse, SetLanPlay, SetScreenResolution, SetupButtonBar, ShowLoginUI, ShowOnlineToast, ShowPlayerCard, StartDedicatedServer, StaticOpenScene, TrimWhitespace, TryCharacterUnlock, UpdateSplitscreenPlayers, ViewportDeProject, ViewportProject


Variables Detail

bForceRefreshOptionList Source code

var transient bool bForceRefreshOptionList;
Whether or not the option list should be refreshed.

bFullyInitialized Source code

var transient bool bFullyInitialized;
Whether or not we're fully initialized yet.

GameMode Source code

var transient string GameMode;

GameModeTab Source code

var transient UTUITabPage_GameModeSelection GameModeTab;
References to the tab control and pages.

GameSettingsTab Source code

var transient UTUITabPage_Options GameSettingsTab;

MapName Source code

var transient string MapName;
Current match settings, used to launch the game. .

MapTab Source code

var transient UTUITabPage_MapSelection MapTab;

SettingsDataStore Source code

var transient UIDataStore_OnlineGameSettings SettingsDataStore;
Reference to the settings datastore that we will use to create the game.

SettingsProfileName Source code

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

StringListDataStore Source code

var transient UTUIDataStore_StringList StringListDataStore;
Reference to the stringlist datastore that we will use to create the game.


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.

OnAcceptGameSettings Source code

function OnAcceptGameSettings ( UIScreenObject InObject, int PlayerIndex) )
Callback for when the user has accepted the game settings.

OnButtonBar_Back Source code

function bool OnButtonBar_Back ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_Next Source code

function bool OnButtonBar_Next ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_StartGame Source code

function bool OnButtonBar_StartGame ( UIScreenObject InButton, int PlayerIndex) )
Buttonbar Callbacks.

OnGameModeSelected Source code

function OnGameModeSelected ( string InGameMode, string InDefaultMap, string GameSettingsClass, bool bSelectionSubmitted) )
Callback for when the gamemode changes on the game mode selection tab.

OnMapSelected Source code

function OnMapSelected ( ) )
Callback for when the user has selected the map.

OnPageActivated Source code

function OnPageActivated ( UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex ) )
Called when a new page is activated.
@param Sender the tab control that activated the page
@param NewlyActivePage the page that was just activated
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.

OnStartGame Source code

function OnStartGame ( )
Starts the game.

PostInitialize Source code

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

SceneActivated Source code

event SceneActivated ( bool bInitialActivation) )
Scene activation event, always sets focus to current tab page if activating the page for a second time.

SetupButtonBar Source code

function SetupButtonBar ( ) )
Sets up the button bar for the scene.

ShowNextTab Source code

function ShowNextTab ( ) )
Shows the next tab page, if we are at the last tab, then we start the game.

ShowPrevTab Source code

function ShowPrevTab ( ) )
Shows the previous tab page, if we are at the first tab, then we close the scene.


Defaultproperties

defaultproperties
{
   bMenuLevelRestoresScene=True
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_LaunchGame"
   ObjectArchetype=UTUIFrontEnd'UTGame.Default__UTUIFrontEnd'
}

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