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

UTGame.UTUIFrontEnd_HostGame

Extends
UTUIFrontEnd_LaunchGame

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Host Game scene for UT3. Contains the host game flow.

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

Constants Summary
MAXIMUM_PLAYER_COUNT=24
SERVERTYPE_LAN=0
SERVERTYPE_RANKED=2
SERVERTYPE_UNRANKED=1

Variables Summary
UTUITabPage_OptionsServerSettingsTab
Inherited Variables from UTGame.UTUIFrontEnd_LaunchGame
bForceRefreshOptionList, bFullyInitialized, GameMode, GameModeTab, GameSettingsTab, MapName, MapTab, SettingsDataStore, SettingsProfileName, StringListDataStore
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText

Enumerations Summary
EBotCombatants
BC_Disabled, BC_Enabled, BC_1_1, BC_3_2, BC_2_1
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport

Functions Summary
function CreateOnlineGame (int PlayerIndex))
function FinishStartDedicated ()))
functionint GenerateMutatorBitmask ()))
functionstring GenerateMutatorURLString ()))
functionbool HandleInputKey (const out InputEventParameters EventParms ))
function OnAcceptServerSettings (UIScreenObject InObject, int PlayerIndex))
function OnGameCreated (bool bWasSuccessful))
function OnGameModeSelected (string InGameMode, string InDefaultMap, string GameSettingsClass, bool bSelectionSubmitted))
function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq ))
function OnServerOptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex))
function OnServerOptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider))
function OnStartDedicated ()))
function OnStartDedicated_Confirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
function OnStartGame ()))
function OnStartGame_Confirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
event PostInitialize ()))
function RefreshGoalScoreOption ()))
function RefreshSplitScreenOption ()))
function SetupBotCombatants ()))
function SetupGameSettings ()))
functionstring StripInvalidPasswordCharacters (string PasswordString, optional string InvalidChars=" \"/:?, " ))
function ValidateServerType ()))
Inherited Functions from UTGame.UTUIFrontEnd_LaunchGame
HandleInputKey, OnAcceptGameSettings, OnButtonBar_Back, OnButtonBar_Next, OnButtonBar_StartGame, OnGameModeSelected, OnMapSelected, OnPageActivated, OnStartGame, PostInitialize, SceneActivated, SetupButtonBar, ShowNextTab, 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


Constants Detail

MAXIMUM_PLAYER_COUNT Source code

const MAXIMUM_PLAYER_COUNT = 24;

SERVERTYPE_LAN Source code

const SERVERTYPE_LAN = 0;

SERVERTYPE_RANKED Source code

const SERVERTYPE_RANKED = 2;

SERVERTYPE_UNRANKED Source code

const SERVERTYPE_UNRANKED = 1;


Variables Detail

ServerSettingsTab Source code

var transient UTUITabPage_Options ServerSettingsTab;
Tab page references for this scene.


Enumerations Detail

EBotCombatants Source code

enum EBotCombatants
{
BC_Disabled, BC_Enabled, BC_1_1, BC_3_2, BC_2_1
};


Functions Detail

CreateOnlineGame Source code

function CreateOnlineGame ( int PlayerIndex) )
Creates the online game and travels to the map we are hosting a server on.

FinishStartDedicated Source code

function FinishStartDedicated ( ) )
Actually starts the dedicated server.

GenerateMutatorBitmask Source code

function int GenerateMutatorBitmask ( ) )
OBSOLETE - use GenerateMutatorURLString

GenerateMutatorURLString Source code

function string GenerateMutatorURLString ( ) )

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.

OnAcceptServerSettings Source code

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

OnGameCreated Source code

function OnGameCreated ( bool bWasSuccessful) )
Callback for when the game is finish being created.

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.

OnMainRegion_Show_UIAnimEnd Source code

function OnMainRegion_Show_UIAnimEnd ( UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq ) )
Handler for the 'show' animation completed.

OnServerOptionChanged Source code

function OnServerOptionChanged ( UIScreenObject InObject, name OptionName, int PlayerIndex) )
Called when one of our options changes.

OnServerOptionFocused Source code

function OnServerOptionFocused ( UIScreenObject InObject, UIDataProvider OptionProvider) )
Called when one of our options is focused

OnStartDedicated Source code

function OnStartDedicated ( ) )
Attempts to start a dedicated server.

OnStartDedicated_Confirm Source code

function OnStartDedicated_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex) )
Callback for the start game message box.

OnStartGame Source code

function OnStartGame ( ) )
Attempts to start an instant action game.

OnStartGame_Confirm Source code

function OnStartGame_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex) )
Callback for the start game message box.

PostInitialize Source code

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

RefreshGoalScoreOption Source code

function RefreshGoalScoreOption ( ) )
Goal score needs to be refreshed because it has different settings depending on game type.

RefreshSplitScreenOption Source code

function RefreshSplitScreenOption ( ) )
Refresh the subscriber value on splitscreen when manual sets to the datastore occur

SetupBotCombatants Source code

function SetupBotCombatants ( ) )
Setup the number of bots and VS ratios depending on how the bot combatants option is configured

SetupGameSettings Source code

function SetupGameSettings ( ) )
Sets up the game settings object using the current options.

StripInvalidPasswordCharacters Source code

static function string StripInvalidPasswordCharacters ( string PasswordString, optional string InvalidChars=" \"/:?,=" ) )
Removes any characters which are not valid to be passed on the URL.

ValidateServerType Source code

function ValidateServerType ( ) )
Enables / disables the "server type" control based on whether we are signed in online.


Defaultproperties

defaultproperties
{
   SettingsProfileName="HostGameMenu"
   bRequiresNetwork=True
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_LaunchGame:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_LaunchGame:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_HostGame"
   ObjectArchetype=UTUIFrontEnd_LaunchGame'UTGame.Default__UTUIFrontEnd_LaunchGame'
}

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