Cogito, ergo sum
UE3:OnlineRecentPlayersList (UDK)
 |
Object >> OnlineRecentPlayersList |
Contents
- 1 Properties
- 2 Structs
- 3 Instance functions
- 3.1 AddPartyToRecentParties
- 3.2 AddPlayerToRecentPlayers
- 3.3 ClearRecentParties
- 3.4 ClearRecentPlayers
- 3.5 DumpPlayersList
- 3.6 GetCurrentPlayersListCount
- 3.7 GetPlayersFromCurrentPlayers
- 3.8 GetPlayersFromRecentParties
- 3.9 GetSkillForCurrentPlayer
- 3.10 GetTeamForCurrentPlayer
- 3.11 SetCurrentPlayersList
- 3.12 SetLastParty
- 3.13 ShowCurrentPlayersList
- 3.14 ShowLastPartyPlayerList
- 3.15 ShowRecentPartiesPlayerList
- 3.16 ShowRecentPlayerList
- Package:
- Engine
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
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[edit]
CurrentPlayers[edit]
Type: array<CurrentPlayerMet>
Modifiers: private
Holds the list of current players (the set of players currently in a session
LastParty[edit]
Type: RecentParty
Holds the information about the last party that a player on this pc/console was in
MaxRecentParties[edit]
Type: int
Modifiers: config
The size of the recent party list to allow before losing the oldest entries
Default value: 5
MaxRecentPlayers[edit]
Type: int
Modifiers: config
The size of the recent player list to allow before losing the oldest entries
Default value: 100
RecentParties[edit]
Type: array<RecentParty>
The list of recent parties that the players on this PC/console has encountered
RecentPartiesAddIndex[edit]
Type: int
The position in the array that new parties should be added at
RecentPlayers[edit]
Type: array<OnlineSubsystem.UniqueNetId>
The set of players that players on this PC/console have recently encountered
RecentPlayersAddIndex[edit]
Type: int
The position in the array that new players should be added at
Structs[edit]
CurrentPlayerMet[edit]
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[edit]
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[edit]
AddPartyToRecentParties[edit]
Adds a player to the recent players list
Parameters:
- PartyLeader - the player being added
- PartyMembers - the members of the party
AddPlayerToRecentPlayers[edit]
Adds a player to the recent players list
Parameters:
- NewPlayer - the player being added
ClearRecentParties[edit]
Clears the recent parties list and resets the add index
ClearRecentPlayers[edit]
Clears the recent players list and resets the add index
DumpPlayersList[edit]
Log list of players for debugging
GetCurrentPlayersListCount[edit]
Returns:
- the number of players in the current player session
GetPlayersFromCurrentPlayers[edit]
Builds a single list of players from the current players list
Parameters:
- Players - the array getting the data copied into it
GetPlayersFromRecentParties[edit]
Builds a single list of players from the recent parties list
Parameters:
- Players - the array getting the data copied into it
GetSkillForCurrentPlayer[edit]
Finds the player indicated and returns their skill rating
Parameters:
- Player - the player to search for
Returns:
- the skill for the specified player
GetTeamForCurrentPlayer[edit]
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[edit]
Sets the current player list to the data specified
Parameters:
- Players - the list of players to copy
SetLastParty[edit]
Adds a player to the recent players list
Parameters:
- PartyLeader - the player being added
- PartyMembers - the members of the party
ShowCurrentPlayersList[edit]
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[edit]
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[edit]
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[edit]
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
