UE3:UTUITabPage_Messages (UT3)

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

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

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

Tab page for messages a user has received.

Properties

MessageBoxReference

Type: UTUIScene_MessageBox

Modifiers: transient

Reference to a message box scene.

MessageList

Type: UIList

Modifiers: transient

PlayerData

Type: UIDataStore_OnlinePlayerData

Modifiers: transient

Reference to the online player datastore.

PlayerInt

Type: OnlinePlayerInterface

Modifiers: transient

Reference to the online player interface.

PlayerMessages

Type: UIDataProvider_OnlineFriendMessages

Modifiers: transient

Reference to the player messages provider.

SendFriendRequestScene

Type: string

Modifiers: transient

Reference to the send friend request screen.

TargetPlayerName

Type: string

Modifiers: transient

Name of the player we are going to send a friend request to.

TargetPlayerNetId

Type: OnlineSubsystem.UniqueNetId

Modifiers: transient

Net ID of the player we are going to send a friend request to.

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

GetNetIdFromIndex

function OnlineSubsystem.UniqueNetId GetNetIdFromIndex (int MessageIdx)

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.

OnButtonBar_DeleteMessage

function bool OnButtonBar_DeleteMessage (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_MarkAsUnread

function bool OnButtonBar_MarkAsUnread (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_ViewMessage

function bool OnButtonBar_ViewMessage (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks

OnDeleteMessage

function OnDeleteMessage ()

Deletes the currently selected message.

OnDeleteMessage_Confirm

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

Confirmation for the delete message dialog.

OnFriendInvite_Confirm

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

Confirmation for the accept friend invite dialog.

OnGameInvite_Confirm

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

Confirmation for the accept game invite dialog.

OnGameInviteAccepted

function OnGameInviteAccepted (OnlineGameSettings GameInviteSettings)

Callback for when the game invite accepted operation has completed.

OnMarkAsUnread

function OnMarkAsUnread ()

Marks the currently selected message as unread.

OnMessageListChanged

function OnMessageListChanged ()

Refreshes the message list.

OnMessagesList_SubmitSelection

function OnMessagesList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Called when the user submits the current list index.

Parameters:

• Sender - the list that is submitting the selection

OnMessagesList_ValueChanged

function OnMessagesList_ValueChanged (UIObject Sender, optional int PlayerIndex)

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

OnPasswordDialog_Closed

private function OnPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

The user has made a selection of the choices available to them.

OnSendFriendRequest

function OnSendFriendRequest ()

Sends a friend request to the owner of this player card.

OnSendFriendRequest_Opened

function OnSendFriendRequest_Opened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the send message scene has actually been opened. Sets the target player for the scene.

OnViewMessage

function OnViewMessage ()

Shows the currently message to the player.

ProcessFollow

private function ProcessFollow (int SelectedMessageItem)

Final function in the "join game invite" process - interacts with the online subsystem to initiate the join. At this point, we've made sure that all conditions for a successful join are met, including prompting the user for the password (if required).

ProcessGameInvite

function ProcessGameInvite (int SelectedMessageItem, optional string ServerPassword)

Wrapper function which displays a prompt dialog if the server we're about to join has a password.

Parameters:

• SelectedMessageItem - the value of the index for the message corresponding to the game invite (i.e. MessageList.Items[MessageList.Index])
• ServerPassword - the password to use when connecting to the game

PromptForServerPassword

private function PromptForServerPassword ()

Displays a dialog to the user which allows him to enter the password for the currently selected server.

SetupButtonBar

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

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