Cogito, ergo sum

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
Line 9: Line 9:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
−
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
Join Game scene for UT3.
 
Join Game scene for UT3.
Line 44: Line 44:
 
Tracks whether a query has been initiated.  Set to TRUE once the first query is started - this is how we catch cases
 
Tracks whether a query has been initiated.  Set to TRUE once the first query is started - this is how we catch cases
 
where the user clicked on the sb tab directly instead of clicking the Search button.
 
where the user clicked on the sb tab directly instead of clicking the Search button.
 +
 +
====bJoinSpectate====
 +
'''Type:''' [[bool]]
 +
 +
<!-- enter variable description -->
 +
 +
====MutatorScene====
 +
'''Type:''' [[string]]
 +
 +
The scene which is opened when the player clicks on the 'Mutator' button
 +
 +
'''Default value:''' "UI_Scenes_FrontEnd.Scenes.BrowserMutatorFilters"
  
 
====ServerBrowserTab====
 
====ServerBrowserTab====
Line 134: Line 146:
 
====OnButtonBar_Back====
 
====OnButtonBar_Back====
 
{{code|function [[bool]]&nbsp;'''OnButtonBar_Back''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 
{{code|function [[bool]]&nbsp;'''OnButtonBar_Back''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
<!-- enter function description -->
 +
 +
====OnButtonBar_JoinIP====
 +
{{code|function [[bool]]&nbsp;'''OnButtonBar_JoinIP''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
<!-- enter function description -->
 +
 +
====OnButtonBar_Mutators====
 +
{{code|function [[bool]]&nbsp;'''OnButtonBar_Mutators''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
Line 141: Line 163:
  
 
Buttonbar Callbacks.
 
Buttonbar Callbacks.
 +
 +
====OnButtonBar_SpectateIP====
 +
{{code|function [[bool]]&nbsp;'''OnButtonBar_SpectateIP''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
<!-- enter function description -->
 +
 +
====OnFilterMutators====
 +
{{code|function '''OnFilterMutators''' ()}}
 +
 +
Called when the user clicks on the 'Mutators' button, to open up the mutator filter menu
 +
 +
====OnJoinIPDialog_Closed====
 +
{{code|function '''OnJoinIPDialog_Closed''' ({{cl|UTUIScene_MessageBox}}&nbsp;'''MessageBox''', [[int]]&nbsp;'''SelectedOption''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
<!-- enter function description -->
  
 
====OnMainRegion_Show_UIAnimEnd====
 
====OnMainRegion_Show_UIAnimEnd====
Line 216: Line 253:
  
 
Switch to the Campaign filter and show the tab
 
Switch to the Campaign filter and show the tab
 +
 +
====UseLANMode====
 +
{{code|function '''UseLANMode''' ()}}
 +
 +
Setup the server filter/browser for LAN mode

Latest revision as of 06:12, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_JoinGame
Package: 
UTGame
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Join Game scene for UT3.

Properties[edit]

bCampaignMode[edit]

Type: bool

Modifiers: transient

true when we're opened via the campaign menu's 'join online game' option

bIssuedInitialFavoritesQuery[edit]

Type: bool

Modifiers: transient

Tracks whether a query has been initiated. Set to TRUE once the first query is started - this is how we catch cases where the user clicked on the sb tab directly instead of clicking the Search button.

bIssuedInitialHistoryQuery[edit]

Type: bool

Modifiers: transient

Tracks whether a query has been initiated. Set to TRUE once the first query is started - this is how we catch cases where the user clicked on the sb tab directly instead of clicking the Search button.

bIssuedInitialQuery[edit]

Type: bool

Modifiers: transient

Tracks whether a query has been initiated. Set to TRUE once the first query is started - this is how we catch cases where the user clicked on the sb tab directly instead of clicking the Search button.

bJoinSpectate[edit]

Type: bool


MutatorScene[edit]

Type: string

The scene which is opened when the player clicks on the 'Mutator' button

Default value: "UI_Scenes_FrontEnd.Scenes.BrowserMutatorFilters"

ServerBrowserTab[edit]

Type: UTUITabPage_ServerBrowser

Tab page references for this scene.

ServerFavoritesTab[edit]

Type: UTUITabPage_ServerFavorites


ServerFilterTab[edit]

Type: UTUITabPage_ServerFilter


ServerHistoryTab[edit]

Type: UTUITabPage_ServerHistory


Default values[edit]

Property Value
bMenuLevelRestoresScene True
bRequiresNetwork True

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneDeactivated[edit]

event SceneDeactivated ()

Overrides: UIScene.SceneDeactivated

Called just after this scene is removed from the active scenes array

Other instance functions[edit]

HandleInputKey[edit]

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.HandleInputKey

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.

Parameters:

  • EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

NotifyOnlineServiceStatusChanged[edit]

function NotifyOnlineServiceStatusChanged (OnlineSubsystem.EOnlineServerConnectionStatus NewConnectionStatus)

Overrides: UIScene.NotifyOnlineServiceStatusChanged

Notification that the player's connection to the platform's online service is changed.

OnAcceptFilterOptions[edit]

function OnAcceptFilterOptions (int PlayerIndex)

Called when the user accepts their filter settings and wants to go to the server browser.

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_JoinIP[edit]

function bool OnButtonBar_JoinIP (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_Mutators[edit]

function bool OnButtonBar_Mutators (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_Search[edit]

function bool OnButtonBar_Search (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnButtonBar_SpectateIP[edit]

function bool OnButtonBar_SpectateIP (UIScreenObject InButton, int PlayerIndex)


OnFilterMutators[edit]

function OnFilterMutators ()

Called when the user clicks on the 'Mutators' button, to open up the mutator filter menu

OnJoinIPDialog_Closed[edit]

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


OnMainRegion_Show_UIAnimEnd[edit]

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

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Handler for the 'show' animation completed.

OnPageActivated[edit]

function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)

Overrides: UTUIFrontEnd.OnPageActivated

Called when the server browser page is activated. Begins a server list query if the page was activated by the user clicking directly on the server browser's tab (as opposed clicking the Search button or pressing enter or something).

Parameters:

  • Sender - the tab control that activated the page
  • NewlyActivePage - the page that was just activated
  • PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this event.

OnServerBrowser_Back[edit]

function OnServerBrowser_Back ()

Called when the user wants to back out of the server browser.

OnServerFilter_AcceptOptions[edit]

function OnServerFilter_AcceptOptions (UIScreenObject InObject, int PlayerIndex)

Called when the user accepts their filter settings and wants to go to the server browser.

OnServerHistory_AddToFavorite[edit]

function OnServerHistory_AddToFavorite ()

Handler for when user moves a server from the server history tab to the server favorites tab; refreshes the server favorites query if the favorites tab is active; otherwise flags the server favorites to be requeried the next time that tab is shown

PreSubmitQuery[edit]

function PreSubmitQuery (UTUITabPage_ServerBrowser ServerBrowser)

Handler for the sb tab's OnPrepareToSubmitQuery delegate. Publishes all configured settings to the game search object.

ServerBrowserChangedGameType[edit]

function ServerBrowserChangedGameType ()

Handler for the server browser panel's OnSwitchedGameType delegate - updates the options in the Filter panel for the newly selected game type.

ServerFilterChangedGameType[edit]

function ServerFilterChangedGameType ()

Handler for the server filter panel's OnSwitchedGameType delegate - updates the combo box on the server browser menu

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the button bar for the scene.

ShowNextTab[edit]

function ShowNextTab ()

Shows the next tab page, if we are at the last tab, then we start the game.

ShowPrevTab[edit]

function ShowPrevTab ()

Shows the previous tab page, if we are at the first tab, then we close the scene.

UseCampaignMode[edit]

function UseCampaignMode ()

Switch to the Campaign filter and show the tab

UseLANMode[edit]

function UseLANMode ()

Setup the server filter/browser for LAN mode

Retrieved from "https://wiki.beyondunreal.com/UE3:UTUIFrontEnd_JoinGame_(UT3)?oldid=35248"