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

UTGame.UTUIFrontEnd_Multiplayer

Extends
UTUIFrontEnd_BasicMenu
Modifiers
dependson ( UTCustomChar_Data ) dependson ( UTUIScene_MessageBox )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Multiplayer Scene for UT3.

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

Constants Summary
MULTIPLAYER_OPTION_HOSTGAME=3
MULTIPLAYER_OPTION_JOINGAME=1
MULTIPLAYER_OPTION_JOINGAMELAN=2
MULTIPLAYER_OPTION_QUICKMATCH=0

Variables Summary
boolbDisplayedNewPlayerMessageBox
boolbProfileNeedsSaving
stringCharacterSelectionScene
stringHostScene
stringJoinScene
stringQuickMatchScene
stringSettingsPanelsScene
Inherited Variables from UTGame.UTUIFrontEnd_BasicMenu
bSupportBackButton, DescriptionLabel, MenuList
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport

Functions Summary
function DisplayNewPlayerMessageBox ()))
functionbool HasSavedCharacterData ()))
function MarkProfileDirty (optional bool bDirty=true ))
function OnChatRestrictionConfirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
function OnFirstTimeCharacter_Confirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
function OnFirstTimeMultiplayer_Confirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
function OnJoinLanScene_Opened (UIScene OpenedScene, bool bInitialActivation))
function OnLoginUI_LoginChange ()))
function OnLoginUI_LoginFailed (byte LocalUserNum, OnlineServerConnectionStatus ErrorCode))
function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
function OnSelectItem (int PlayerIndex=GetPlayerIndex()))
function OnSettingsSceneOpened (UIScene OpenedScene, bool bInitialActivation))
function OnSettingValueChanged (UIScreenObject InObject, name OptionName, int PlayerIndex))
function PerformMultiplayerChecks ()))
function SettingsSceneClosed (UIScene DeactivatedScene ))
Inherited Functions from UTGame.UTUIFrontEnd_BasicMenu
HandleInputKey, OnBack, OnButtonBar_Back, OnButtonBar_Select, OnMenu_SubmitSelection, OnMenu_ValueChanged, OnSelectItem, PostInitialize, SetupButtonBar
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

MULTIPLAYER_OPTION_HOSTGAME Source code

const MULTIPLAYER_OPTION_HOSTGAME = 3;

MULTIPLAYER_OPTION_JOINGAME Source code

const MULTIPLAYER_OPTION_JOINGAME = 1;

MULTIPLAYER_OPTION_JOINGAMELAN Source code

const MULTIPLAYER_OPTION_JOINGAMELAN = 2;

MULTIPLAYER_OPTION_QUICKMATCH Source code

const MULTIPLAYER_OPTION_QUICKMATCH = 0;


Variables Detail

bDisplayedNewPlayerMessageBox Source code

var transient bool bDisplayedNewPlayerMessageBox;
Whether or not we have already displayed the new player message box to the user.

bProfileNeedsSaving Source code

var transient bool bProfileNeedsSaving;
indicates that the player's profile should be saved

CharacterSelectionScene Source code

var string CharacterSelectionScene;
Reference to the character selection scene.

HostScene Source code

var string HostScene;
Reference to the host game scene.

JoinScene Source code

var string JoinScene;
Reference to the join game scene.

QuickMatchScene Source code

var string QuickMatchScene;
Reference to the quick match scene.

SettingsPanelsScene Source code

var string SettingsPanelsScene;
Reference to the settings panels scene.


Functions Detail

DisplayNewPlayerMessageBox Source code

function DisplayNewPlayerMessageBox ( ) )
Displays a messagebox if the player doesn't have a custom character set.

HasSavedCharacterData Source code

function bool HasSavedCharacterData ( ) )

@return bool Returns whether or not this user has saved character data.

MarkProfileDirty Source code

function MarkProfileDirty ( optional bool bDirty=true ) )
Called when the profile has been modified and needs to be saved.

OnChatRestrictionConfirm Source code

function OnChatRestrictionConfirm ( UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex) )
Called when the user dismisses the "you can't chat online" message box

OnFirstTimeCharacter_Confirm Source code

function OnFirstTimeCharacter_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex) )
Callback when the user dismisses the firsttime character message box.

OnFirstTimeMultiplayer_Confirm Source code

function OnFirstTimeMultiplayer_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex) )
Callback when the user dismisses the firsttime multiplayer message box.

OnJoinLanScene_Opened Source code

function OnJoinLanScene_Opened ( UIScene OpenedScene, bool bInitialActivation) )
Callback for when the join scene has opened for LAN.

OnLoginUI_LoginChange Source code

function OnLoginUI_LoginChange ( ) )
Callback for when the login changes after showing the login UI.

OnLoginUI_LoginFailed Source code

function OnLoginUI_LoginFailed ( byte LocalUserNum,EOnlineServerConnectionStatus ErrorCode) )
Delegate used in notifying the UI/game that the manual login failed after showing the login UI.
@param LocalUserNum the controller number of the associated user
@param ErrorCode the async error code that occurred

OnMainRegion_Show_UIAnimEnd Source code

function OnMainRegion_Show_UIAnimEnd ( UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq) )
Called when the screen has finished showing.

OnSelectItem Source code

function OnSelectItem ( int PlayerIndex=GetPlayerIndex()) )
Executes a action based on the currently selected menu item.

OnSettingsSceneOpened Source code

function OnSettingsSceneOpened ( UIScene OpenedScene, bool bInitialActivation) )
Callback for when the settings scene has opened.

OnSettingValueChanged Source code

function OnSettingValueChanged ( UIScreenObject InObject, name OptionName, int PlayerIndex) )
Handler for the OnOptionChanged delegate of the first time settings panel; called when the user changes the value for an option

PerformMultiplayerChecks Source code

function PerformMultiplayerChecks ( ) )
Checks various conditions required to play online and displays the relevant messages to the user if any online features will be disabled.

SettingsSceneClosed Source code

function SettingsSceneClosed ( UIScene DeactivatedScene ) )


Defaultproperties

defaultproperties
{
   QuickMatchScene="UI_Scenes_ChrisBLayout.Scenes.QuickMatch"
   HostScene="UI_Scenes_ChrisBLayout.Scenes.HostGame"
   JoinScene="UI_Scenes_FrontEnd.Scenes.JoinGame"
   CharacterSelectionScene="UI_Scenes_ChrisBLayout.Scenes.CharacterFaction"
   SettingsPanelsScene="UI_Scenes_ChrisBLayout.Scenes.SettingsPanels"
   bRequiresNetwork=True
   bMenuLevelRestoresScene=True
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_Multiplayer"
   ObjectArchetype=UTUIFrontEnd_BasicMenu'UTGame.Default__UTUIFrontEnd_BasicMenu'
}

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