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

UTGame.UTUIScene_SendOnlineMessage

Extends
UTUIFrontEnd_CustomScreen

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Friend request scene for UT3, allows the player to send a friend request.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd
               |   
               +-- UTGame.UTUIFrontEnd_CustomScreen
                  |   
                  +-- UTGame.UTUIScene_SendOnlineMessage

Variables Summary
UIEditBoxMessageEditBox
UILabelPlayerNameLabel
stringTargetPlayerName
UniqueNetIdTargetPlayerNetId
Inherited Variables from UTGame.UTUIFrontEnd_CustomScreen
bIsPasswordKeyboard, DescriptionLabel, DescriptionMap, KeyboardTargetEditBox
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport

Structures Summary
Inherited Structures from UTGame.UTUIFrontEnd_CustomScreen
DescriptionMapping

Functions Summary
functionbool HandleInputKey (const out InputEventParameters EventParms ))
functionbool OnButtonBar_Cancel (UIScreenObject InButton, int InPlayerIndex))
functionbool OnButtonBar_SendMessage (UIScreenObject InButton, int InPlayerIndex))
functionbool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex))
function OnCancel ()))
function OnMessageResultBoxClosed ()))
function OnSendMessage ()))
function OnShowKeyboard ()))
functionbool OnSubmitText (UIEditBox Sender, int PlayerIndex ))
event PostInitialize ()))
function SetTargetPlayer (UniqueNetId InTargetPlayerNetId, string InTargetPlayerName))
function SetupButtonBar ()))
Inherited Functions from UTGame.UTUIFrontEnd_CustomScreen
OnKeyboardInputComplete, OnNotifyActiveStateChanged, PostInitialize, ShowKeyboard, StripInvalidUsernameCharacters
Inherited Functions from UTGame.UTUIFrontEnd
BeginHideAnimation, BeginImportMod, BeginInstallPS3, BeginShowAnimation, CancelInstallPS3, CheckForFrontEndError, ChildSceneOpened, GetTitleLabel, HandleInputKey, ImportMod, InstallPS3, OnCancelInstallPS3, OnCancelMessageClosed, OnImportModFinished, OnInstallMessageClosed, OnLoginError_Confirm, OnMainRegion_Show_UIAnimEnd, OnPageActivated, OnRetryPasswordDialog_Closed, OnTabPage_Hide_UIAnimEnd, OnTabPage_Show_UIAnimEnd, PostInitialize, PromptForPassword, SavePassword, SceneActivated, SetTitle, SetupButtonBar, UpdateModState, UpdatePS3InstallState


Variables Detail

MessageEditBox Source code

var transient UIEditBox MessageEditBox;
References to the editboxes on the screen.

PlayerNameLabel Source code

var transient UILabel PlayerNameLabel;
Reference to a label that shows the target player's name.

TargetPlayerName Source code

var transient string TargetPlayerName;
Person to send the message to.

TargetPlayerNetId Source code

var transient UniqueNetId TargetPlayerNetId;


Functions Detail

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

function bool OnButtonBar_Cancel ( UIScreenObject InButton, int InPlayerIndex) )
Buttonbar Callbacks.

OnButtonBar_SendMessage Source code

function bool OnButtonBar_SendMessage ( UIScreenObject InButton, int InPlayerIndex) )

OnButtonBar_ShowKeyboard Source code

function bool OnButtonBar_ShowKeyboard ( UIScreenObject InButton, int InPlayerIndex) )

OnCancel Source code

function OnCancel ( ) )
Callback for when the user wants to back out of this screen.

OnMessageResultBoxClosed Source code

function OnMessageResultBoxClosed ( ) )
Called when the user has closed the request sent box.

OnSendMessage Source code

function OnSendMessage ( ) )
Sends the actual friend request.

OnShowKeyboard Source code

function OnShowKeyboard ( ) )
Shows the online keyboard.

OnSubmitText Source code

function bool OnSubmitText ( UIEditBox Sender, int PlayerIndex ) )
Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.
@param Sender the editbox that is submitting text
@param PlayerIndex the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.
@return if TRUE, the editbox will clear the existing value of its textbox.

PostInitialize Source code

event PostInitialize ( ) )

SetTargetPlayer Source code

function SetTargetPlayer ( UniqueNetId InTargetPlayerNetId, string InTargetPlayerName) )
Sets who the message should be sent to.

SetupButtonBar Source code

function SetupButtonBar ( ) )
Sets up the scene's button bar.


Defaultproperties

defaultproperties
{
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_CustomScreen:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_CustomScreen:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIScene_SendOnlineMessage"
   ObjectArchetype=UTUIFrontEnd_CustomScreen'UTGame.Default__UTUIFrontEnd_CustomScreen'
}

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