UE3:UTUITabPage_FriendsList (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_FriendsList

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

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

Tab page for a user's friends list.

Properties

FriendsList

Type: UIList

Modifiers: transient

SendFriendRequestScene

Type: string

Default value: "UI_Scenes_Common.SendFriendRequest"

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions

GetCurrentFriendNetId

function bool GetCurrentFriendNetId (out OnlineSubsystem.UniqueNetId FriendNetId)

Gets the netid for the currently selected friend.

Parameters:

• FriendNetId - Object to store netid in.

Returns:

TRUE if a netid was found, FALSE otherwise.

GetCurrentFriendNick

function bool GetCurrentFriendNick (out string FriendNick)

Gets the nickname for the currently selected friend.

Parameters:

• FriendNick - String to store nickname in.

Returns:

TRUE if a nickname was found, FALSE otherwise.

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTTabPage.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.

OnAddFriend

function OnAddFriend ()

Shows the add friend screen for the player.

OnButtonBar_AddFriend

function bool OnButtonBar_AddFriend (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks

OnButtonBar_Details

function bool OnButtonBar_Details (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_RemoveFriend

function bool OnButtonBar_RemoveFriend (UIScreenObject InButton, int PlayerIndex)

OnDetails

function OnDetails ()

Shows the details screen for the player.

OnFriendsList_SubmitSelection

function OnFriendsList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Called when the user submits the current list index.

Parameters:

• Sender - the list that is submitting the selection

OnFriendsList_ValueChanged

function OnFriendsList_ValueChanged (UIObject Sender, optional int PlayerIndex)

Callback for when the user changes the currently selected list item.

OnRemoveFriend

function OnRemoveFriend ()

Removes the current friend from the user's friend list.

OnRemoveFriend_Confirm

function OnRemoveFriend_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Confirmation for the exit game dialog.

SetupButtonBar

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

Callback allowing the tabpage to setup the button bar for the current scene.