FOnlineAchievementsAccelByte Class Reference

Inheritance diagram for FOnlineAchievementsAccelByte:

Public Member Functions
virtual void	QueryAchievements (const FUniqueNetId &PlayerId, const FOnQueryAchievementsCompleteDelegate &Delegate) override
virtual void	QueryAchievements (const FUniqueNetId &PlayerId, const FAccelByteQueryAchievementsParameters &RequestParameters, const FOnQueryAchievementsCompleteDelegate &Delegate)
virtual void	QueryAchievementDescriptions (const FUniqueNetId &PlayerId, const FOnQueryAchievementsCompleteDelegate &Delegate) override
virtual void	QueryAchievementDescriptions (const FUniqueNetId &PlayerId, const FAccelByteQueryAchievementDescriptionParameters &RequestParameters, const FOnQueryAchievementsCompleteDelegate &Delegate)
virtual void	WriteAchievements (const FUniqueNetId &PlayerId, FOnlineAchievementsWriteRef &WriteObject, const FOnAchievementsWrittenDelegate &Delegate) override
virtual EOnlineCachedResult::Type	GetCachedAchievementDescription (const FString &AchievementId, FOnlineAchievementDesc &OutAchievementDesc) override
virtual EOnlineCachedResult::Type	GetCachedAchievements (const FUniqueNetId &PlayerId, TArray< FOnlineAchievement > &OutAchievements) override
virtual EOnlineCachedResult::Type	GetCachedAchievement (const FUniqueNetId &PlayerId, const FString &AchievementId, FOnlineAchievement &OutAchievement) override
virtual bool	ResetAchievements (const FUniqueNetId &PlayerId) override
void	SendPSNEvents (const FAccelByteModelsAchievementBulkCreatePSNEventRequest &Request, const FOnSendPSNEventsCompleteDelegate &CompletionDelegate)
	UE_BUILD_SHIPPING.
void	UnlockAchievementBulkOperation (const FUniqueNetId &UserID, TArray< FString > AchievementCodes, const FOnBulkAchievementUnlockDelegate &OperationResponseDelegate)
	Unlock multiple achievement for current user.
void	UnlockAchievementBulkOperationByGameServer (const FUniqueNetId &UserID, TArray< FString > AchievementCodes, const FOnBulkAchievementUnlockDelegate &OperationResponseDelegate)
	Game server perform unlock multiple achievement for the specified user.
void	UnlockAchievementBulkOperationByGameServer (const FString &AccelByteUserID, TArray< FString > AchievementCodes, const FOnBulkAchievementUnlockDelegate &OperationResponseDelegate)

Static Public Member Functions
static bool	GetFromSubsystem (const IOnlineSubsystem *Subsystem, TSharedPtr< FOnlineAchievementsAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)
static bool	GetFromWorld (const UWorld *World, TSharedPtr< FOnlineAchievementsAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)

Protected Attributes
FOnlineSubsystemAccelByteWPtr	AccelByteSubsystem

Member Function Documentation

QueryAchievementDescriptions() [1/2]

void FOnlineAchievementsAccelByte::QueryAchievementDescriptions ( const FUniqueNetId & PlayerId, const FAccelByteQueryAchievementDescriptionParameters & RequestParameters, const FOnQueryAchievementsCompleteDelegate & Delegate )

virtual

Used by a user to query a list of all available achievements.

Parameters

PlayerId	- User ID requesting to query their achievements
RequestParameters	- Request parameters that contains of Sort By, Page, Tag and Global Achievement Flag. Each of the optional parameters have their own default value.
Delegate	- Return delegate indicating the success of this method

QueryAchievementDescriptions() [2/2]

void FOnlineAchievementsAccelByte::QueryAchievementDescriptions ( const FUniqueNetId & PlayerId, const FOnQueryAchievementsCompleteDelegate & Delegate )

overridevirtual

[DEPRECATED] Please use the new 'QueryAllAchievements' for the replacement Used by a user to query a list of all available achievements.

Parameters

PlayerId	- User ID requesting to query their achievements
Delegate	- Return delegate indicating the success of this method

QueryAchievements() [1/2]

void FOnlineAchievementsAccelByte::QueryAchievements ( const FUniqueNetId & PlayerId, const FAccelByteQueryAchievementsParameters & RequestParameters, const FOnQueryAchievementsCompleteDelegate & Delegate )

virtual

Used by a user to query a list of their achievements. Include achieved and in-progress.

Parameters

PlayerId	- User ID requesting to query their achievements
RequestParameters	- Optional parameters that contains of Sort By, Page, Tag and Unlocked Flag. Each of the optional parameters have their own default value.
Delegate	- Return delegate indicating the success of this method

QueryAchievements() [2/2]

void FOnlineAchievementsAccelByte::QueryAchievements ( const FUniqueNetId & PlayerId, const FOnQueryAchievementsCompleteDelegate & Delegate )

overridevirtual

[DEPRECATED] Please use the new 'QueryUserAchievements' for the replacement Used by a user to query a list of their achievements. Include achieved and in-progress.

Parameters

PlayerId	- User ID requesting to query their achievements
Delegate	- Return delegate indicating the success of this method

SendPSNEvents()

void FOnlineAchievementsAccelByte::SendPSNEvents	(	const FAccelByteModelsAchievementBulkCreatePSNEventRequest &	Request,
		const FOnSendPSNEventsCompleteDelegate &	CompletionDelegate )

UE_BUILD_SHIPPING.

Server call to send events pertaining to achievements to PSN

Parameters

Request	Request model describing events to send to PSN
CompletionDelegate	Delegate fired when request to send PSN events has completed

UnlockAchievementBulkOperation()

void FOnlineAchievementsAccelByte::UnlockAchievementBulkOperation	(	const FUniqueNetId &	UserID,
		TArray< FString >	AchievementCodes,
		const FOnBulkAchievementUnlockDelegate &	OperationResponseDelegate )

Unlock multiple achievement for current user.

Parameters

UserID	Current local user that will unlock its achievement.
AchievementCodes	Collection of achievement code that will be unlocked for the targete user.
OperationResponseDelegate	Delegate that inform the result of the operation, consists an array of result.

UnlockAchievementBulkOperationByGameServer()

void FOnlineAchievementsAccelByte::UnlockAchievementBulkOperationByGameServer	(	const FUniqueNetId &	UserID,
		TArray< FString >	AchievementCodes,
		const FOnBulkAchievementUnlockDelegate &	OperationResponseDelegate )

Game server perform unlock multiple achievement for the specified user.

Parameters

UserID	Targeted user operation.
AchievementCodes	Collection of achievement code that will be unlocked for the targete user.
OperationResponseDelegate	Delegate that inform the result of the operation, consists an array of result.