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

UTGame.UTUITabPage_Messages

Extends
UTTabPage
Modifiers
placeable dependson ( UTUIScene_MessageBox )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Tab page for messages a user has received.

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

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

Variables Summary
UTUIScene_MessageBoxMessageBoxReference
UIListMessageList
UIDataStore_OnlinePlayerDataPlayerData
OnlinePlayerInterfacePlayerInt
UIDataProvider_OnlineFriendMessagesPlayerMessages
stringSendFriendRequestScene
stringTargetPlayerName
UniqueNetIdTargetPlayerNetId
Inherited Variables from UTGame.UTTabPage
bRequiresTick
Inherited Variables from Engine.UITabPage
ButtonCaption, ButtonClass, ButtonToolTip, PageDescription, TabButton

Functions Summary
functionUniqueNetId GetNetIdFromIndex (int MessageIdx))
functionbool HandleInputKey (const out InputEventParameters EventParms ))
functionbool OnButtonBar_DeleteMessage (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_MarkAsUnread (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_ViewMessage (UIScreenObject InButton, int PlayerIndex))
function OnDeleteMessage ()))
function OnDeleteMessage_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
function OnFriendInvite_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
function OnGameInviteAccepted (OnlineGameSettings GameInviteSettings))
function OnGameInvite_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
function OnMarkAsUnread ()))
function OnMessageListChanged ()))
function OnMessagesList_SubmitSelection (UIList Sender, optional int PlayerIndex=0 ))
function OnMessagesList_ValueChanged (UIObject Sender, optional int PlayerIndex=0 ))
function OnPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
function OnSendFriendRequest ()))
function OnSendFriendRequest_Opened (UIScene OpenedScene, bool bInitialActivation))
function OnViewMessage ()))
event PostInitialize ()))
function ProcessFollow (int SelectedMessageItem ))
function ProcessGameInvite (int SelectedMessageItem, optional string ServerPassword ))
function PromptForServerPassword ()))
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

MessageBoxReference Source code

var transient UTUIScene_MessageBox MessageBoxReference;
Reference to a message box scene.

MessageList Source code

var transient UIList MessageList;

PlayerData Source code

var transient UIDataStore_OnlinePlayerData PlayerData;
Reference to the online player datastore.

PlayerInt Source code

var transient OnlinePlayerInterface PlayerInt;
Reference to the online player interface.

PlayerMessages Source code

var transient UIDataProvider_OnlineFriendMessages PlayerMessages;
Reference to the player messages provider.

SendFriendRequestScene Source code

var transient string SendFriendRequestScene;
Reference to the send friend request screen.

TargetPlayerName Source code

var transient string TargetPlayerName;
Name of the player we are going to send a friend request to.

TargetPlayerNetId Source code

var transient UniqueNetId TargetPlayerNetId;
Net ID of the player we are going to send a friend request to.


Functions Detail

GetNetIdFromIndex Source code

function UniqueNetId GetNetIdFromIndex ( int MessageIdx) )

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.

OnButtonBar_DeleteMessage Source code

function bool OnButtonBar_DeleteMessage ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_MarkAsUnread Source code

function bool OnButtonBar_MarkAsUnread ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_ViewMessage Source code

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

OnDeleteMessage Source code

function OnDeleteMessage ( ) )
Deletes the currently selected message.

OnDeleteMessage_Confirm Source code

function OnDeleteMessage_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the delete message dialog.

OnFriendInvite_Confirm Source code

function OnFriendInvite_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the accept friend invite dialog.

OnGameInviteAccepted Source code

function OnGameInviteAccepted ( OnlineGameSettings GameInviteSettings) )
Callback for when the game invite accepted operation has completed.

OnGameInvite_Confirm Source code

function OnGameInvite_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex) )
Confirmation for the accept game invite dialog.

OnMarkAsUnread Source code

function OnMarkAsUnread ( ) )
Marks the currently selected message as unread.

OnMessageListChanged Source code

function OnMessageListChanged ( ) )
Refreshes the message list.

OnMessagesList_SubmitSelection Source code

function OnMessagesList_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

OnMessagesList_ValueChanged Source code

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

OnPasswordDialog_Closed Source code

private function OnPasswordDialog_Closed ( UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex) )
The user has made a selection of the choices available to them.

OnSendFriendRequest Source code

function OnSendFriendRequest ( ) )
Sends a friend request to the owner of this player card.

OnSendFriendRequest_Opened Source code

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 Source code

function OnViewMessage ( ) )
Shows the currently message to the player.

PostInitialize Source code

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

ProcessFollow Source code

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 Source code

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.
@param SelectedMessageItem the value of the index for the message corresponding to the game invite (i.e. MessageList.Items[MessageList.Index])
@param ServerPassword the password to use when connecting to the game

PromptForServerPassword Source code

private function PromptForServerPassword ( ) )
Displays a dialog to the user which allows him to enter the password for the currently selected server.

SetupButtonBar Source code

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


Defaultproperties

defaultproperties
{
   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_Messages"
   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.708 - Created with UnCodeX