UE3:UTUIScene_SendFriendRequest (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_CustomScreen >> UTUIScene_SendFriendRequest

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

MessageEditBox

Type: UIEditBox

Modifiers: transient

TargetPlayerName

Type: string

Modifiers: transient

Person to send the friend invite to.

TargetPlayerNetId

Type: OnlineSubsystem.UniqueNetId

Modifiers: transient

UserNameEditBox

Type: UIEditBox

Modifiers: transient

References to the editboxes on the screen.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_CustomScreen.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd_CustomScreen.PostInitialize

PostInitialize event - Sets delegates for the scene.

Other instance functions

HandleInputKey

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.

OnAddFriendByNameComplete

function OnAddFriendByNameComplete (bool bWasSuccessful)

Called when a friend invite arrives for a local player

Parameters:

• bWasSuccessful - true if successfully added, false if not found or failed

OnButtonBar_Cancel

function bool OnButtonBar_Cancel (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnButtonBar_SendFriendRequest

function bool OnButtonBar_SendFriendRequest (UIScreenObject InButton, int InPlayerIndex)

OnButtonBar_ShowKeyboard

function bool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex)

OnCancel

function OnCancel ()

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

OnRequestSentMessageClosed

function OnRequestSentMessageClosed ()

Called when the user has closed the request sent box.

OnSendFriendRequest

function OnSendFriendRequest ()

Sends the actual friend request.

OnShowKeyboard

function OnShowKeyboard ()

Shows the online keyboard.

OnSubmitText

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

function SetTargetPlayer (OnlineSubsystem.UniqueNetId InTargetPlayerNetId, string InTargetPlayerName)

Sets who the message should be sent to.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the scene's button bar.