UE3:UTUIFrontEnd_Multiplayer (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_BasicMenu >> UTUIFrontEnd_Multiplayer

Package: 

UTGame

This class in other games:

UDK

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

Multiplayer Scene for UT3.

Constants

MULTIPLAYER_OPTION_QUICKMATCH

Value: 0

MULTIPLAYER_OPTION_JOINGAME

Value: 1

MULTIPLAYER_OPTION_JOINGAMELAN

Value: 2

MULTIPLAYER_OPTION_HOSTGAME

Value: 3

Properties

bDisplayedNewPlayerMessageBox

Type: bool

Modifiers: transient

Whether or not we have already displayed the new player message box to the user.

bProfileNeedsSaving

Type: bool

Modifiers: transient

indicates that the player's profile should be saved

CharacterSelectionScene

Type: string

Reference to the character selection scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.CharacterFaction"

HostScene

Type: string

Reference to the host game scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.HostGame"

JoinScene

Type: string

Reference to the join game scene.

Default value: "UI_Scenes_FrontEnd.Scenes.JoinGame"

QuickMatchScene

Type: string

Reference to the quick match scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.QuickMatch"

SettingsPanelsScene

Type: string

Reference to the settings panels scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.SettingsPanels"

Default values

Property	Value
bMenuLevelRestoresScene	True
bRequiresNetwork	True

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Instance functions

DisplayNewPlayerMessageBox

function DisplayNewPlayerMessageBox ()

Displays a messagebox if the player doesn't have a custom character set.

HasSavedCharacterData

function bool HasSavedCharacterData ()

Returns:

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

MarkProfileDirty

function MarkProfileDirty (optional bool bDirty)

Called when the profile has been modified and needs to be saved.

OnChatRestrictionConfirm

function OnChatRestrictionConfirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

Called when the user dismisses the "you can't chat online" message box

OnFirstTimeCharacter_Confirm

function OnFirstTimeCharacter_Confirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

Callback when the user dismisses the firsttime character message box.

OnFirstTimeMultiplayer_Confirm

function OnFirstTimeMultiplayer_Confirm (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

Callback when the user dismisses the firsttime multiplayer message box.

OnJoinLanScene_Opened

function OnJoinLanScene_Opened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the join scene has opened for LAN.

OnLoginUI_LoginChange

function OnLoginUI_LoginChange ()

Overrides: UTUIScene.OnLoginUI_LoginChange

Callback for when the login changes after showing the login UI.

OnLoginUI_LoginFailed

function OnLoginUI_LoginFailed (byte LocalUserNum, OnlineSubsystem.EOnlineServerConnectionStatus ErrorCode)

Overrides: UTUIScene.OnLoginUI_LoginFailed

Delegate used in notifying the UI/game that the manual login failed after showing the login UI.

Parameters:

• LocalUserNum - the controller number of the associated user
• ErrorCode - the async error code that occurred

OnMainRegion_Show_UIAnimEnd

function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Called when the screen has finished showing.

OnSelectItem

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

OnSettingsSceneOpened

function OnSettingsSceneOpened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the settings scene has opened.

OnSettingValueChanged

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

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

function SettingsSceneClosed (UIScene DeactivatedScene)