UE3:UIDataProvider_PlayerAchievements (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_PlayerAchievements

Package: 

Engine

Implemented interfaces: 

UIListElementCellProvider

This class is responsible for providing access to information about the achievements available to the player

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

Properties

Achievements

Type: array<OnlineSubsystem.AchievementDetails>

Modifiers: transient

Functions

Native functions

GetMaxTotalGamerScore

native final function int GetMaxTotalGamerScore () const

Returns the number of gamer points that can be acquired in this game across all achievements

Returns:

The maximum number of gamer points allocated for each game.

GetTotalGamerScore

native final function int GetTotalGamerScore () const

Returns the number of gamer points this profile has accumulated across all achievements

Returns:

a number between 0 and the maximum number of gamer points allocated for each game (currently 1000), representing the total gamer points earned from all achievements for this profile.

Events

OnRegister

event OnRegister (LocalPlayer InPlayer)

Overrides: UIDataProvider_OnlinePlayerDataBase.OnRegister

Binds the player to this provider. Starts the async friends list gathering

Parameters:

• InPlayer - the player that we are retrieving friends for

OnUnregister

event OnUnregister ()

Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister

Clears our delegate for getting login change notifications

Other instance functions

GetAchievementDetails

function GetAchievementDetails (const int AchievementId, out OnlineSubsystem.AchievementDetails OutAchievementDetails)

Gets achievement details based on achievement id

Parameters:

• AchievementId - EGearAchievement for which to find details
• OutAchievementDetails - AchievementDetails struct to be populated

GetAchievementIconPathName

function string GetAchievementIconPathName (int AchievementId, optional bool bReturnLockedIcon)

Wrapper for retrieving the path name of an achievement's icon.

OnLoginChange

function OnLoginChange (byte LocalUserNum)

Handlers for the player's login changed delegate. Refreshes the list of achievements.

Parameters:

• LocalUserNum - the player that logged in/out

OnPlayerAchievementsChanged

function OnPlayerAchievementsChanged (int TitleId)

Called when the async achievements read has completed

Parameters:

• TitleId - the title id that the read was for (0 means current title)

OnPlayerAchievementUnlocked

function OnPlayerAchievementUnlocked (bool bWasSuccessful)

Handler for online service's callback for the player unlocking an achievement.

PopulateAchievementIcons

function PopulateAchievementIcons ()

Loads the achievement icons from the .ini and applies them to the list of achievements.

UpdateAchievements

function UpdateAchievements ()

Queries the online service for the player's list of achievements.