UE3:UTUIScene_PlayerCard (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_BasicMenu >> UTUIScene_PlayerCard

Package: 

UTGame

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

Player card scene for UT3, allows players to add friends, invite to games, etc.

Properties

AccountLabel

Type: UILabel

Modifiers: transient

Reference to the label that displays the account name

bWasAbleToJoin

Type: bool

Modifiers: transient

Whether or not we were able to join a friend's game in progress.

CurrentOptions

Type: array<PlayerCardOptions>

Modifiers: transient

Current array of options visible to the player.

DescLinks

Type: string

Array size: 6

Default value, index 0: "SendFriendRequest_Desc"

Default value, index 1: "SendMessage_Desc"

Default value, index 2: "InviteToGame_Desc"

Default value, index 3: "Follow_Desc"

Default value, index 4: "Kick_Desc"

Default value, index 5: "Ban_Desc"

PlayerInt

Type: OnlinePlayerInterface

Modifiers: transient

Reference to the online player interface.

PlayerName

Type: string

Modifiers: transient

Name of the player we are showing the card for.

PlayerNameLabel

Type: UILabel

Modifiers: transient

Reference to a label that displays the name of the player that this card belongs to.

PlayerNetId

Type: OnlineSubsystem.UniqueNetId

Modifiers: transient

Net ID of the player we are showing the card for.

SendFriendRequestScene

Type: string

Modifiers: transient

Reference to the send friend request screen.

SendOnlineMessageScene

Type: string

Modifiers: transient

Reference to the send online message screen.

StringListDataStore

Type: UTUIDataStore_StringList

Modifiers: transient

Reference to the string list datastore.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Enums

PlayerCardOptions

PCO_SendFriendRequest 

PCO_SendMessage 

PCO_InviteToGame 

PCO_Follow 

PCO_Kick 

PCO_Ban 

Functions

Static functions

FollowRequiresPassword

static function bool FollowRequiresPassword (UTPlayerController UTPlayerOwner, const out OnlineSubsystem.UniqueNetId FriendNetId)

Determines whether we need to supply a password in order to join this friend's match.

Returns:

TRUE if the friend's server is password-protected; FALSE otherwise.

GetOnlineFriendData

static function bool GetOnlineFriendData (UTPlayerController OwnerPC, const out OnlineSubsystem.UniqueNetId FriendNetId, out OnlineSubsystem.OnlineFriend out_FriendData)

Gets the OnlineFriend struct for the player we're displaying this player card for.

Parameters:

• OwnerPC - the player controller associated with the player to get friend info from (i.e. the local player)
• FriendNetId - the unique network id associated with the friend to get info for (i.e. the friend)
• out_FriendData - receives the online friend data

Returns:

FALSE if this player isn't one of our friends or the OnlineFriend data couldn't be found.

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd_BasicMenu.PostInitialize

Post initialize callback.

Other instance functions

BanSelection

function BanSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

GenerateOptions

function GenerateOptions (bool bIncludeKickOption, bool bIncludeBanOption)

Generates the options for the player card menu based on the users's current relationship to the player in question.

KickSelection

function KickSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

OnBan

function OnBan ()

OnFollow

function OnFollow (optional string ServerPassword)

Tries to follow the player that owns this playercard by joining their current game.

OnFollowComplete

function OnFollowComplete (bool bWasSuccessful)

Called once the join task has completed

Parameters:

• bWasSuccessful - the session was found and is joinable, false otherwise

OnInviteToGame

function OnInviteToGame ()

Invites the owner of this player card to the local player's game.

OnJoiningMessage_Closed

function OnJoiningMessage_Closed ()

Callback for when the joining messagebox has closed.

OnKick

function OnKick ()

OnMenu_ValueChanged

function OnMenu_ValueChanged (UIObject Sender, optional int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnMenu_ValueChanged

Called 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.

OnSelectItem

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

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.

OnSendMessage

function OnSendMessage ()

Displays the send online message scene for the owner of this card.

OnSendMessageScene_Opened

function OnSendMessageScene_Opened (UIScene OpenedScene, bool bInitialActivation)

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

ProcessFollow

private function ProcessFollow ()

PromptForServerPassword

private function PromptForServerPassword ()

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

SetPlayer

function SetPlayer (OnlineSubsystem.UniqueNetId InNetId, string InPlayerName, optional string InAccountName, optional bool bIncludeKickOption, optional bool bIncludeBanOption)

Sets the current player for this player card.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd_BasicMenu.SetupButtonBar

Setup the scene's buttonbar.