Gah - a solution with more questions. – EntropicLqd

UE3:UTUIScene_SendOnlineMessage (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_CustomScreen >> UTUIScene_SendOnlineMessage
Package: 
UTGame

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

Friend request scene for UT3, allows the player to send a friend request.

Properties[edit]

MessageEditBox[edit]

Type: UIEditBox

Modifiers: transient

References to the editboxes on the screen.

PlayerNameLabel[edit]

Type: UILabel

Modifiers: transient

Reference to a label that shows the target player's name.

TargetPlayerName[edit]

Type: string

Modifiers: transient

Person to send the message to.

TargetPlayerNetId[edit]

Type: OnlineSubsystem.UniqueNetId

Modifiers: transient


Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_CustomScreen.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd_CustomScreen.PostInitialize

PostInitialize event - Sets delegates for the scene.

Other instance functions[edit]

HandleInputKey[edit]

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.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_Cancel[edit]

function bool OnButtonBar_Cancel (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnButtonBar_SendMessage[edit]

function bool OnButtonBar_SendMessage (UIScreenObject InButton, int InPlayerIndex)


OnButtonBar_ShowKeyboard[edit]

function bool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex)


OnCancel[edit]

function OnCancel ()

Callback for when the user wants to back out of this screen.

OnMessageResultBoxClosed[edit]

function OnMessageResultBoxClosed ()

Called when the user has closed the request sent box.

OnSendMessage[edit]

function OnSendMessage ()

Sends the actual friend request.

OnShowKeyboard[edit]

function OnShowKeyboard ()

Shows the online keyboard.

OnSubmitText[edit]

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.

Parameters:

  • Sender - the editbox that is submitting text
  • 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.

Returns:

if TRUE, the editbox will clear the existing value of its textbox.

SetTargetPlayer[edit]

function SetTargetPlayer (OnlineSubsystem.UniqueNetId InTargetPlayerNetId, string InTargetPlayerName)

Sets who the message should be sent to.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the scene's button bar.