My program doesn't have bugs. It just develops random features.

Difference between revisions of "UE3:UTUIFrontEnd Multiplayer (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
Line 10: Line 10:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
Multiplayer Scene for UT3.
 
Multiplayer Scene for UT3.
Line 25: Line 25:
 
<!-- enter constant description -->
 
<!-- enter constant description -->
  
====MULTIPLAYER_OPTION_HOSTGAME====
+
====MULTIPLAYER_OPTION_JOINGAMELAN====
 
'''Value:''' 2
 
'''Value:''' 2
 +
 +
<!-- enter constant description -->
 +
 +
====MULTIPLAYER_OPTION_HOSTGAME====
 +
'''Value:''' 3
  
 
<!-- enter constant description -->
 
<!-- enter constant description -->
Line 131: Line 136:
  
 
Callback when the user dismisses the firsttime multiplayer message box.
 
Callback when the user dismisses the firsttime multiplayer message box.
 +
 +
====OnJoinLanScene_Opened====
 +
{{code|function '''OnJoinLanScene_Opened''' ({{cl|UIScene}}&nbsp;'''OpenedScene''', [[bool]]&nbsp;'''bInitialActivation''')}}
 +
 +
Callback for when the join scene has opened for LAN.
  
 
====OnLoginUI_LoginChange====
 
====OnLoginUI_LoginChange====
Line 168: Line 178:
  
 
Callback for when the settings scene has opened.
 
Callback for when the settings scene has opened.
 +
 +
====OnSettingValueChanged====
 +
{{code|function '''OnSettingValueChanged''' ({{cl|UIScreenObject}}&nbsp;'''InObject''', [[name]]&nbsp;'''OptionName''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
Handler for the OnOptionChanged delegate of the first time settings panel; called when the user changes the value for an option
  
 
====PerformMultiplayerChecks====
 
====PerformMultiplayerChecks====

Latest revision as of 06:16, 16 August 2009

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[edit]

MULTIPLAYER_OPTION_QUICKMATCH[edit]

Value: 0


MULTIPLAYER_OPTION_JOINGAME[edit]

Value: 1


MULTIPLAYER_OPTION_JOINGAMELAN[edit]

Value: 2


MULTIPLAYER_OPTION_HOSTGAME[edit]

Value: 3


Properties[edit]

bDisplayedNewPlayerMessageBox[edit]

Type: bool

Modifiers: transient

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

bProfileNeedsSaving[edit]

Type: bool

Modifiers: transient

indicates that the player's profile should be saved

CharacterSelectionScene[edit]

Type: string

Reference to the character selection scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.CharacterFaction"

HostScene[edit]

Type: string

Reference to the host game scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.HostGame"

JoinScene[edit]

Type: string

Reference to the join game scene.

Default value: "UI_Scenes_FrontEnd.Scenes.JoinGame"

QuickMatchScene[edit]

Type: string

Reference to the quick match scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.QuickMatch"

SettingsPanelsScene[edit]

Type: string

Reference to the settings panels scene.

Default value: "UI_Scenes_ChrisBLayout.Scenes.SettingsPanels"

Default values[edit]

Property Value
bMenuLevelRestoresScene True
bRequiresNetwork True

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Instance functions[edit]

DisplayNewPlayerMessageBox[edit]

function DisplayNewPlayerMessageBox ()

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

HasSavedCharacterData[edit]

function bool HasSavedCharacterData ()

Returns:

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

MarkProfileDirty[edit]

function MarkProfileDirty (optional bool bDirty)

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

OnChatRestrictionConfirm[edit]

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

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

OnFirstTimeCharacter_Confirm[edit]

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

Callback when the user dismisses the firsttime character message box.

OnFirstTimeMultiplayer_Confirm[edit]

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

Callback when the user dismisses the firsttime multiplayer message box.

OnJoinLanScene_Opened[edit]

function OnJoinLanScene_Opened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the join scene has opened for LAN.

OnLoginUI_LoginChange[edit]

function OnLoginUI_LoginChange ()

Overrides: UTUIScene.OnLoginUI_LoginChange

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

OnLoginUI_LoginFailed[edit]

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[edit]

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

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Called when the screen has finished showing.

OnSelectItem[edit]

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

OnSettingsSceneOpened[edit]

function OnSettingsSceneOpened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the settings scene has opened.

OnSettingValueChanged[edit]

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[edit]

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[edit]

function SettingsSceneClosed (UIScene DeactivatedScene)