UE3:OnlineRecentPlayersList (UDK)

Object >> OnlineRecentPlayersList

Package: 

Engine

This class holds a list of players met online that the players on this PC/console encountered. It does not persist the list. Both parties and individuals are tracked with the individuals containing all party members. Note that it only holds the unique ids of the players.

Properties

CurrentPlayers

Type: array<CurrentPlayerMet>

Modifiers: private

Holds the list of current players (the set of players currently in a session

LastParty

Type: RecentParty

Holds the information about the last party that a player on this pc/console was in

MaxRecentParties

Type: int

Modifiers: config

The size of the recent party list to allow before losing the oldest entries

Default value: 5

MaxRecentPlayers

Type: int

Modifiers: config

The size of the recent player list to allow before losing the oldest entries

Default value: 100

RecentParties

Type: array<RecentParty>

The list of recent parties that the players on this PC/console has encountered

RecentPartiesAddIndex

Type: int

The position in the array that new parties should be added at

RecentPlayers

Type: array<OnlineSubsystem.UniqueNetId>

The set of players that players on this PC/console have recently encountered

RecentPlayersAddIndex

Type: int

The position in the array that new players should be added at

Structs

CurrentPlayerMet

The set of people that the player/PC/console are currently playing with/against

int TeamNum 

The team the player is on

int Skill 

The skill rating of the player

OnlineSubsystem.UniqueNetId NetId 

The unique net id for the player

RecentParty

Holds a set of players that made up a party

OnlineSubsystem.UniqueNetId PartyLeader 

The player that was the party leader

array<OnlineSubsystem.UniqueNetId> PartyMembers 

The list of players that comprise the party (should include the leader)

Instance functions

AddPartyToRecentParties

function AddPartyToRecentParties (OnlineSubsystem.UniqueNetId PartyLeader, const out array<OnlineSubsystem.UniqueNetId> PartyMembers)

Adds a player to the recent players list

Parameters:

• PartyLeader - the player being added
• PartyMembers - the members of the party

AddPlayerToRecentPlayers

function AddPlayerToRecentPlayers (OnlineSubsystem.UniqueNetId NewPlayer)

Adds a player to the recent players list

Parameters:

• NewPlayer - the player being added

ClearRecentParties

function ClearRecentParties ()

Clears the recent parties list and resets the add index

ClearRecentPlayers

function ClearRecentPlayers ()

Clears the recent players list and resets the add index

DumpPlayersList

function DumpPlayersList (const out array<CurrentPlayerMet> Players)

Log list of players for debugging

GetCurrentPlayersListCount

function int GetCurrentPlayersListCount ()

Returns:

the number of players in the current player session

GetPlayersFromCurrentPlayers

function GetPlayersFromCurrentPlayers (out array<OnlineSubsystem.UniqueNetId> Players)

Builds a single list of players from the current players list

Parameters:

• Players - the array getting the data copied into it

GetPlayersFromRecentParties

function GetPlayersFromRecentParties (out array<OnlineSubsystem.UniqueNetId> Players)

Builds a single list of players from the recent parties list

Parameters:

• Players - the array getting the data copied into it

GetSkillForCurrentPlayer

function int GetSkillForCurrentPlayer (OnlineSubsystem.UniqueNetId Player)

Finds the player indicated and returns their skill rating

Parameters:

• Player - the player to search for

Returns:

the skill for the specified player

GetTeamForCurrentPlayer

function int GetTeamForCurrentPlayer (OnlineSubsystem.UniqueNetId Player)

Finds the player indicated and returns their team that was assigned

Parameters:

• Player - the player to search for

Returns:

the team number for the specified player

SetCurrentPlayersList

function SetCurrentPlayersList (const array<CurrentPlayerMet> Players)

Sets the current player list to the data specified

Parameters:

• Players - the list of players to copy

SetLastParty

function SetLastParty (OnlineSubsystem.UniqueNetId PartyLeader, const out array<OnlineSubsystem.UniqueNetId> PartyMembers)

Adds a player to the recent players list

Parameters:

• PartyLeader - the player being added
• PartyMembers - the members of the party

ShowCurrentPlayersList

function bool ShowCurrentPlayersList (byte LocalUserNum, string Title, string Description)

Builds a single player list out of the players in the current players list

Parameters:

• LocalUserNum - the controller number of the associated user
• Title - the title to use for the UI
• Description - the text to show at the top of the UI

Returns:

TRUE if it was able to show the UI, FALSE if it failed

ShowLastPartyPlayerList

function bool ShowLastPartyPlayerList (byte LocalUserNum, string Title, string Description)

Shows the last party that you were in as a player list

Parameters:

• LocalUserNum - the controller number of the associated user
• Title - the title to use for the UI
• Description - the text to show at the top of the UI

Returns:

TRUE if it was able to show the UI, FALSE if it failed

ShowRecentPartiesPlayerList

function bool ShowRecentPartiesPlayerList (byte LocalUserNum, string Title, string Description)

Builds a single player list out of the various parties encountered and shows

Parameters:

• LocalUserNum - the controller number of the associated user
• Title - the title to use for the UI
• Description - the text to show at the top of the UI

Returns:

TRUE if it was able to show the UI, FALSE if it failed

ShowRecentPlayerList

function bool ShowRecentPlayerList (byte LocalUserNum, string Title, string Description)

Helper function for showing the recent players list

Parameters:

• LocalUserNum - the controller number of the associated user
• Title - the title to use for the UI
• Description - the text to show at the top of the UI

Returns:

TRUE if it was able to show the UI, FALSE if it failed