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

UTGame.UTUITabPage_FriendsList

Extends
UTTabPage
Modifiers
placeable

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Tab page for a user's friends list.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UITabPage
               |   
               +-- UTGame.UTTabPage
                  |   
                  +-- UTGame.UTUITabPage_FriendsList

Constants Summary
Inherited Contants from Engine.UITabPage
CAPTION_DATABINDING_INDEX, DESCRIPTION_DATABINDING_INDEX, TOOLTIP_DATABINDING_INDEX

Variables Summary
UIListFriendsList
stringSendFriendRequestScene
Inherited Variables from UTGame.UTTabPage
bRequiresTick
Inherited Variables from Engine.UITabPage
ButtonCaption, ButtonClass, ButtonToolTip, PageDescription, TabButton

Functions Summary
functionbool GetCurrentFriendNetId (out UniqueNetId FriendNetId))
functionbool GetCurrentFriendNick (out string FriendNick))
functionbool HandleInputKey (const out InputEventParameters EventParms ))
function OnAddFriend ()))
functionbool OnButtonBar_AddFriend (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_Details (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_RemoveFriend (UIScreenObject InButton, int PlayerIndex))
function OnDetails ()))
function OnFriendsList_SubmitSelection (UIList Sender, optional int PlayerIndex=0 ))
function OnFriendsList_ValueChanged (UIObject Sender, optional int PlayerIndex=0 ))
function OnRemoveFriend ()))
function OnRemoveFriend_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
event PostInitialize ()))
function SetupButtonBar (UTUIButtonBar ButtonBar))
Inherited Functions from UTGame.UTTabPage
CloseParentScene, GetButtonBar, HandleInputKey, OnChildRepositioned, SetupButtonBar
Inherited Functions from Engine.UITabPage
ActivatePage, AddedToTabControl, CanActivatePage, ClearBoundDataStores, CreateTabButton, GetBoundDataStores, GetDataStoreBinding, GetOwnerTabControl, GetTabButton, IsActivePage, LinkToTabButton, NotifyDataStoreValueUpdated, OnActiveStateChanged, RefreshSubscriberValue, RemovedFromParent, SetDataStoreBinding, SetTabCaption


Variables Detail

FriendsList Source code

var transient UIList FriendsList;

SendFriendRequestScene Source code

var string SendFriendRequestScene;


Functions Detail

GetCurrentFriendNetId Source code

function bool GetCurrentFriendNetId ( out UniqueNetId FriendNetId) )
Gets the netid for the currently selected friend.
@param FriendNetId Object to store netid in.
@return TRUE if a netid was found, FALSE otherwise.

GetCurrentFriendNick Source code

function bool GetCurrentFriendNick ( out string FriendNick) )
Gets the nickname for the currently selected friend.
@param FriendNick String to store nickname in.
@return TRUE if a nickname was found, FALSE otherwise.

HandleInputKey Source code

function bool HandleInputKey ( const out InputEventParameters EventParms ) )
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.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnAddFriend Source code

function OnAddFriend ( ) )
Shows the add friend screen for the player.

OnButtonBar_AddFriend Source code

function bool OnButtonBar_AddFriend ( UIScreenObject InButton, int PlayerIndex) )
Buttonbar Callbacks

OnButtonBar_Details Source code

function bool OnButtonBar_Details ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_RemoveFriend Source code

function bool OnButtonBar_RemoveFriend ( UIScreenObject InButton, int PlayerIndex) )

OnDetails Source code

function OnDetails ( ) )
Shows the details screen for the player.

OnFriendsList_SubmitSelection Source code

function OnFriendsList_SubmitSelection ( UIList Sender, optional int PlayerIndex=0 ) )
Called when the user submits the current list index.
@param Sender the list that is submitting the selection

OnFriendsList_ValueChanged Source code

function OnFriendsList_ValueChanged ( UIObject Sender, optional int PlayerIndex=0 ) )
Callback for when the user changes the currently selected list item.

OnRemoveFriend Source code

function OnRemoveFriend ( ) )
Removes the current friend from the user's friend list.

OnRemoveFriend_Confirm Source code

function OnRemoveFriend_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the exit game dialog.

PostInitialize Source code

event PostInitialize ( ) )
Post initialization event - Setup widget delegates.

SetupButtonBar Source code

function SetupButtonBar ( UTUIButtonBar ButtonBar) )
Callback allowing the tabpage to setup the button bar for the current scene.


Defaultproperties

defaultproperties
{
   SendFriendRequestScene="UI_Scenes_Common.SendFriendRequest"
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUITabPage_FriendsList"
   ObjectArchetype=UTTabPage'UTGame.Default__UTTabPage'
}

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