Cogito, ergo sum

Difference between revisions of "UE3:UTUITabPage ServerFavorites (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
Line 18: Line 18:
  
 
==Properties==
 
==Properties==
 +
====AddIPIdx====
 +
'''Type:''' [[int]]
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' transient
 +
 +
<!-- enter variable description -->
 +
 +
====QueryHelper====
 +
'''Type:''' {{cl|UTQueryHelper}}
 +
 +
Reference to the query helper object, which performs the query for retrieving server details from an IP
 +
 
====RemoveFavoriteIdx====
 
====RemoveFavoriteIdx====
 
'''Type:''' [[int]]
 
'''Type:''' [[int]]
Line 49: Line 61:
  
 
Adjusts the layout of the scene based on the current platform
 
Adjusts the layout of the scene based on the current platform
 +
 +
====FindServerByIPComplete====
 +
{{code|function '''FindServerByIPComplete''' ({{tl|OnlineGameSearchResult|OnlineGameSearch}}&nbsp;'''Result''')}}
 +
 +
<!-- enter function description -->
  
 
====GetDesiredMatchType====
 
====GetDesiredMatchType====
Line 63: Line 80:
  
 
Wrapper for getting a reference to the favorites data store.
 
Wrapper for getting a reference to the favorites data store.
 +
 +
====OnAddIPDialog_Closed====
 +
{{code|function '''OnAddIPDialog_Closed''' ({{cl|UTUIScene_MessageBox}}&nbsp;'''MessageBox''', [[int]]&nbsp;'''SelectedOption''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
<!-- enter function description -->
 +
 +
====OnButtonBar_AddIP====
 +
{{code|function [[bool]]&nbsp;'''OnButtonBar_AddIP''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''InPlayerIndex''')}}
 +
 +
ButtonBar - Add IP to favourites
  
 
====OnButtonBar_RemoveFavorite====
 
====OnButtonBar_RemoveFavorite====

Latest revision as of 07:42, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_ServerBrowser >> UTUITabPage_ServerFavorites
Package: 
UTGame
Implemented interfaces: 
UIDataStoreSubscriber
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.

This class is a specialized server browser which displays only those servers which the player has marked as a favorite. This server browser does not respect filter options.

Copyright 2007 Epic Games, Inc. All Rights Reserved

Properties[edit]

AddIPIdx[edit]

Type: int

Modifiers: transient


QueryHelper[edit]

Type: UTQueryHelper

Reference to the query helper object, which performs the query for retrieving server details from an IP

RemoveFavoriteIdx[edit]

Type: int

Modifiers: transient


Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUITabPage_ServerBrowser.WidgetEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUITabPage_ServerBrowser.PostInitialize

Sets the correct tab button caption.

Other instance functions[edit]

AdjustLayout[edit]

function AdjustLayout ()

Overrides: UTUITabPage_ServerBrowser.AdjustLayout

Adjusts the layout of the scene based on the current platform

FindServerByIPComplete[edit]

function FindServerByIPComplete (OnlineGameSearch.OnlineGameSearchResult Result)


GetDesiredMatchType[edit]

function int GetDesiredMatchType ()

Overrides: UTUITabPage_ServerBrowser.GetDesiredMatchType

Determines which type of matches the user wishes to search for (i.e. LAN, unranked, ranked, etc.)

GetFavoritesDataStore[edit]

function UTDataStore_GameSearchFavorites GetFavoritesDataStore ()

Overrides: UTUITabPage_ServerBrowser.GetFavoritesDataStore

Wrapper for getting a reference to the favorites data store.

OnAddIPDialog_Closed[edit]

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


OnButtonBar_AddIP[edit]

function bool OnButtonBar_AddIP (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Add IP to favourites

OnButtonBar_RemoveFavorite[edit]

function bool OnButtonBar_RemoveFavorite (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Remove from favorite

RemoveFavorite[edit]

function RemoveFavorite (int inPlayerIndex)

Removes the currently selected server from the list of favorites

SetupExtraButtons[edit]

function SetupExtraButtons (UTUIButtonBar ButtonBar)

Overrides: UTUITabPage_ServerBrowser.SetupExtraButtons

Provides an easy way for child classes to add additional buttons before the ButtonBar's button states are updated

UpdateButtonStates[edit]

function UpdateButtonStates ()

Overrides: UTUITabPage_ServerBrowser.UpdateButtonStates

Updates the enabled state of certain button bar buttons depending on whether a server is selected or not.

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