UTGame.UTUIScene_PlayerCard

Extends

UTUIFrontEnd_BasicMenu

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Player card scene for UT3, allows players to add friends, invite to games, etc.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd
               |   
               +-- UTGame.UTUIFrontEnd_BasicMenu
                  |   
                  +-- UTGame.UTUIScene_PlayerCard

Functions Summary
		BanSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
	bool	FollowRequiresPassword (UTPlayerController UTPlayerOwner, const out OnlineSubsystem.UniqueNetId FriendNetId ))
		GenerateOptions (bool bIncludeKickOption, bool bIncludeBanOption))
	bool	GetOnlineFriendData (UTPlayerController OwnerPC, const out OnlineSubsystem.UniqueNetId FriendNetId, out OnlineSubsystem.OnlineFriend out_FriendData ))
		KickSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
		OnBan ()))
		OnFollow (optional string ServerPassword ))
		OnFollowComplete (bool bWasSuccessful))
		OnInviteToGame ()))
		OnJoiningMessage_Closed ()))
		OnKick ()))
		OnMenu_ValueChanged (UIObject Sender, optional int PlayerIndex=0 ))
		OnPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
		OnSelectItem (int PlayerIndex=0))
		OnSendFriendRequest ()))
		OnSendFriendRequest_Opened (UIScene OpenedScene, bool bInitialActivation))
		OnSendMessage ()))
		OnSendMessageScene_Opened (UIScene OpenedScene, bool bInitialActivation))
		PostInitialize ()))
		ProcessFollow ()))
		PromptForServerPassword ()))
		SetPlayer (UniqueNetId InNetId, string InPlayerName, optional string InAccountName, optional bool bIncludeKickOption, optional bool bIncludeBanOption))
		SetupButtonBar ()))

AccountLabel Source code

Reference to the label that displays the account name

bWasAbleToJoin Source code

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

CurrentOptions Source code

Current array of options visible to the player.

DescLinks[6] Source code

PlayerInt Source code

Reference to the online player interface.

PlayerName Source code

Name of the player we are showing the card for.

PlayerNameLabel Source code

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

PlayerNetId Source code

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

SendFriendRequestScene Source code

Reference to the send friend request screen.

SendOnlineMessageScene Source code

Reference to the send online message screen.

StringListDataStore Source code

Reference to the string list datastore.

PlayerCardOptions Source code

BanSelection Source code

FollowRequiresPassword Source code

Determines whether we need to supply a password in order to join this friend's match.
@return TRUE if the friend's server is password-protected; FALSE otherwise.

GenerateOptions Source code

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

GetOnlineFriendData Source code

Gets the OnlineFriend struct for the player we're displaying this player card for.
@param OwnerPC the player controller associated with the player to get friend info from (i.e. the local player)
@param FriendNetId the unique network id associated with the friend to get info for (i.e. the friend)
@param out_FriendData receives the online friend data
@return FALSE if this player isn't one of our friends or the OnlineFriend data couldn't be found.

KickSelection Source code

OnBan Source code

OnFollow Source code

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

OnFollowComplete Source code

Called once the join task has completed
@param bWasSuccessful the session was found and is joinable, false otherwise

OnInviteToGame Source code

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

OnJoiningMessage_Closed Source code

Callback for when the joining messagebox has closed.

OnKick Source code

OnMenu_ValueChanged Source code

Called when the user changes the currently selected list item.

OnPasswordDialog_Closed Source code

The user has made a selection of the choices available to them.

OnSelectItem Source code

Executes a action based on the currently selected menu item.

OnSendFriendRequest Source code

Sends a friend request to the owner of this player card.

OnSendFriendRequest_Opened Source code

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

OnSendMessage Source code

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

OnSendMessageScene_Opened Source code

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

PostInitialize Source code

ProcessFollow Source code

PromptForServerPassword Source code

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

SetPlayer Source code

Sets the current player for this player card.

SetupButtonBar Source code

Setup the scene's buttonbar.

defaultproperties
{
   DescLinks(0)="SendFriendRequest_Desc"
   DescLinks(1)="SendMessage_Desc"
   DescLinks(2)="InviteToGame_Desc"
   DescLinks(3)="Follow_Desc"
   DescLinks(4)="Kick_Desc"
   DescLinks(5)="Ban_Desc"
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIScene_PlayerCard"
   ObjectArchetype=UTUIFrontEnd_BasicMenu'UTGame.Default__UTUIFrontEnd_BasicMenu'
}