OnlinePicoAchievements Blueprint Function class. More...

#include <Pico_Achievements.h>

Static Public Member Functions
static void	PicoAddCount (UObject *WorldContextObject, const FString &Name, const FString &Count, const FString &ExtraData, FAddCount InAddCountCallback)
	Adds a count to a specified count achievement. The count will be added to the current count, for example, if the current count is 1 and the count you would like to add is 7, the final count will be 8 if the request succeeds. More...

static void	PicoAddFields (UObject *WorldContextObject, const FString &Name, const FString &Fields, const FString &ExtraData, FAddFields InAddFieldsCallback)
	Unlocks the bit(s) of a specified bitfield achievement. The status of the bit(s) is then unchangeable. More...

static void	PicoUnlock (UObject *WorldContextObject, const FString &Name, const FString &ExtraData, FUnlock InUnlockCallback)
	Unlocks a specified achievement of any type even if the target for unlocking this achievement is not reached. More...

static void	PicoGetAllDefinitions (UObject *WorldContextObject, int32 PageIndex, int32 PageSize, FGetAllDefinitions InGetAllDefinitionsCallback)
	Gets the information about all achievements, including API names, descriptions, types, the targets which must be reached to unlock those achievements, and more. More...

static void	PicoGetAllProgress (UObject *WorldContextObject, int32 PageIndex, int32 PageSize, FGetAllProgress InGetAllProgressCallback)
	Gets the user's progress on all achievements, including API names, whether or not the achievements are unlocked, the time at which they were unlocked, achievement types and, depending on the type, the progress made towards unlocking them, and more. More...

static void	PicoGetDefinitionsByName (UObject *WorldContextObject, const TArray< FString > &NameArray, FGetDefinitionsByName InGetDefinitionsByNameCallback)
	Gets the information about specified achievements, including API names, descriptions, types, the targets which must be reached to unlock those achievements, and more. More...

static void	PicoGetProgressByName (UObject *WorldContextObject, const TArray< FString > &NameArray, FGetProgressByName InGetProgressByNameCallback)
	Gets the user's progress on specified achievements, including API names, whether or not the achievements are unlocked, the time at which they were unlocked, achievement types and, depending on the type, the progress made towards unlocking them, and more. More...

Detailed Description

OnlinePicoAchievements Blueprint Function class.

Member Function Documentation

◆ PicoAddCount()

void PicoAddCount	(	UObject *	WorldContextObject,
		const FString &	Name,
		const FString &	Count,
		const FString &	ExtraData,
		FAddCount	InAddCountCallback
	)

static

Adds a count to a specified count achievement. The count will be added to the current count, for example, if the current count is 1 and the count you would like to add is 7, the final count will be 8 if the request succeeds.

Note: Available to count achievements only.

Parameters

WorldContextObject	Used to get the information about the current world.
Name	The API name of the achievement.
Count	The count you want to add. The largest count supported by this function is the maximum value of a signed 64-bit integer. If the count is larger than that, it is clamped to that maximum value before being passed to the servers.
ExtraData	Custom extension fields that can be used to record key information when unlocking achievements.
InAddCountCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ PicoAddFields()

void PicoAddFields	(	UObject *	WorldContextObject,
		const FString &	Name,
		const FString &	Fields,
		const FString &	ExtraData,
		FAddFields	InAddFieldsCallback
	)

static

Unlocks the bit(s) of a specified bitfield achievement. The status of the bit(s) is then unchangeable.

Note: Available to bitfield achievements only.

Parameters

WorldContextObject	Used to get the information about the current world.
Name	The API name of the achievement to unlock bit(s) for.
Fields	A string containing either '0' or '1' characters, for example '100011'. Every '1' will unlock a bit in the corresponding position of a bitfield.
ExtraData	Custom extension fields that can be used to record key information when unlocking achievements.
InAddFieldsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ PicoGetAllDefinitions()

void PicoGetAllDefinitions	(	UObject *	WorldContextObject,
		int32	PageIndex,
		int32	PageSize,
		FGetAllDefinitions	InGetAllDefinitionsCallback
	)

static

Gets the information about all achievements, including API names, descriptions, types, the targets which must be reached to unlock those achievements, and more.

Parameters

WorldContextObject	Used to get the information about the current world.
PageIndex	The start index of the pages.
PageSize	The size of the page.
InGetAllDefinitionsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ PicoGetAllProgress()

void PicoGetAllProgress	(	UObject *	WorldContextObject,
		int32	PageIndex,
		int32	PageSize,
		FGetAllProgress	InGetAllProgressCallback
	)

static

Gets the user's progress on all achievements, including API names, whether or not the achievements are unlocked, the time at which they were unlocked, achievement types and, depending on the type, the progress made towards unlocking them, and more.

Parameters

WorldContextObject	Used to get the information about the current world.
PageIndex	The start index of the pages.
PageSize	The size of the page.
InGetAllProgressCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ PicoGetDefinitionsByName()

void PicoGetDefinitionsByName	(	UObject *	WorldContextObject,
		const TArray< FString > &	NameArray,
		FGetDefinitionsByName	InGetDefinitionsByNameCallback
	)

static

Gets the information about specified achievements, including API names, descriptions, types, the targets which must be reached to unlock those achievements, and more.

Parameters

WorldContextObject	Used to get the information about the current world.
NameArray	The API names of the achievements.
InGetDefinitionsByNameCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ PicoGetProgressByName()

void PicoGetProgressByName	(	UObject *	WorldContextObject,
		const TArray< FString > &	NameArray,
		FGetProgressByName	InGetProgressByNameCallback
	)

static

Gets the user's progress on specified achievements, including API names, whether or not the achievements are unlocked, the time at which they were unlocked, achievement types and, depending on the type, the progress made towards unlocking them, and more.

Parameters

WorldContextObject	Used to get the information about the current world.
NameArray	The API names of the achievements.
InGetProgressByNameCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

◆ PicoUnlock()

void PicoUnlock	(	UObject *	WorldContextObject,
		const FString &	Name,
		const FString &	ExtraData,
		FUnlock	InUnlockCallback
	)

static

Unlocks a specified achievement of any type even if the target for unlocking this achievement is not reached.

Parameters

WorldContextObject	Used to get the information about the current world.
Name	The API name of the achievement to unlock.
ExtraData	Custom extension fields that can be used to record key information when unlocking achievements.
InUnlockCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

true: success
false: failure

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ PicoAddCount()

◆ PicoAddFields()

◆ PicoGetAllDefinitions()

◆ PicoGetAllProgress()

◆ PicoGetDefinitionsByName()

◆ PicoGetProgressByName()

◆ PicoUnlock()