Description

Function library that allows access to the Omni Achievements Service via Blueprint.

#include <OmniAchievementService.h>

Inherits UBlueprintFunctionLibrary.

Methods
static void	OmniAddCount (UObject *WorldContext, const FString &Name, const int64 Count, const FString &ExtraData, FAddCountDelegate AddCountCallback)
	Updates a count achievement, adding the passed-in amount to the previous count of the achievement.

static void	OmniAddFields (UObject *WorldContext, const FString &Name, const FString &Fields, const FString &ExtraData, FAddFieldsDelegate AddFieldsCallback)
	Updates a bitfield achievement.

static void	OmniUnlock (UObject *WorldContext, const FString &Name, const FString &ExtraData, FUnlockDelegate UnlockCallback)
	Unlocks the specified achievement.

static void	OmniGetProgressByName (UObject *WorldContext, const TArray< FString > &Names, FGetProgressByNameDelegate GetProgressByNameCallback)
	Retrieves information about one or more achievements, by their API names.

static void	OmniGetAllProgress (UObject *WorldContext, const int32 PageIndex, const int32 PageSize, FGetAllProgressDelegate GetAllProgressCallback)
	Gets information about the progress of all achievements, supporting pagination.

static void	OmniGetDefinitionsByName (UObject *WorldContext, const TArray< FString > &Names, FGetDefinitionsByNameDelegate GetDefinitionsByNameCallback)
	Retrieves information about one or more achievement definitions, by their API names.

static void	OmniGetAllDefinitions (UObject *WorldContext, const int32 PageIndex, const int32 PageSize, FGetAllDefinitionsDelegate GetAllDefinitionsCallback)
	Gets information about the definitions of all achievements, supporting pagination.

Methods

◆ OmniAddCount()

static void UOmniAchievementsFunctions::OmniAddCount	(	UObject *	WorldContext,
		const FString &	Name,
		const int64	Count,
		const FString &	ExtraData,
		FAddCountDelegate	AddCountCallback
	)

static

Updates a count achievement, adding the passed-in amount to the previous count of the achievement.

This function is the blueprint counterpart of FOmniAchievementService::AddCount.

Parameters

WorldContext	Reference to the world context.
Name	The API name of the achievement.
Count	The amount to add to the count of the achievement.
ExtraData	Any additional data that may be necessary.
AddCountCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementUpdate* (null in error cases) are passed as parameters.

◆ OmniAddFields()

static void UOmniAchievementsFunctions::OmniAddFields	(	UObject *	WorldContext,
		const FString &	Name,
		const FString &	Fields,
		const FString &	ExtraData,
		FAddFieldsDelegate	AddFieldsCallback
	)

static

Updates a bitfield achievement.

Sets provided fields of a bitfield achievement. un-set fields can be set this way, but already-set fields will remain set. For example, if an achievement has fields "00001", and this method is called with fields "10000", the new fields of the achievement would be "10001". This function is the blueprint counterpart of FOmniAchievementService::AddFields.

Parameters

WorldContext	Reference to the world context.
Name	The API name of the achievement.
Fields	A string of '1' and '0' representing the fields. '1' represents a set field, '0' represents an un-set field..
ExtraData	Any additional data that may be necessary.
AddFieldsCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementUpdate* (null in error cases) are passed as parameters.

◆ OmniGetAllDefinitions()

static void UOmniAchievementsFunctions::OmniGetAllDefinitions	(	UObject *	WorldContext,
		const int32	PageIndex,
		const int32	PageSize,
		FGetAllDefinitionsDelegate	GetAllDefinitionsCallback
	)

static

Gets information about the definitions of all achievements, supporting pagination.

Parameters

WorldContext	Reference to the world context.
PageIndex	The page index of the values to return, 0-indexed.
PageSize	The maximum number of values that should be returned.
GetAllDefinitionsCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementDefinitionArray* (null in error cases) are passed as parameters.

◆ OmniGetAllProgress()

static void UOmniAchievementsFunctions::OmniGetAllProgress	(	UObject *	WorldContext,
		const int32	PageIndex,
		const int32	PageSize,
		FGetAllProgressDelegate	GetAllProgressCallback
	)

static

Gets information about the progress of all achievements, supporting pagination.

Parameters

WorldContext	Reference to the world context.
PageIndex	The page index of the values to return, 0-indexed.
PageSize	The maximum number of values that should be returned.
GetAllProgressCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementProgressArray* (null in error cases) are passed as parameters.

◆ OmniGetDefinitionsByName()

static void UOmniAchievementsFunctions::OmniGetDefinitionsByName	(	UObject *	WorldContext,
		const TArray< FString > &	Names,
		FGetDefinitionsByNameDelegate	GetDefinitionsByNameCallback
	)

static

Retrieves information about one or more achievement definitions, by their API names.

Parameters

WorldContext	Reference to the world context.
Names	An array containing the API names of each of the requested achievement definitions.
GetDefinitionsByNameCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementDefinitionArray* (null in error cases) are passed as parameters.

◆ OmniGetProgressByName()

static void UOmniAchievementsFunctions::OmniGetProgressByName	(	UObject *	WorldContext,
		const TArray< FString > &	Names,
		FGetProgressByNameDelegate	GetProgressByNameCallback
	)

static

Retrieves information about one or more achievements, by their API names.

This function is the blueprint counterpart of FOmniAchievementService::GetProgressByName.

Parameters

WorldContext	Reference to the world context.
Names	An array containing the API names of each of the requested achievements.
GetProgressByNameCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementProgressArray* (null in error cases) are passed as parameters.

◆ OmniUnlock()

static void UOmniAchievementsFunctions::OmniUnlock	(	UObject *	WorldContext,
		const FString &	Name,
		const FString &	ExtraData,
		FUnlockDelegate	UnlockCallback
	)

static

Unlocks the specified achievement.

This will work for all achievements, not just Simple ones.

This function is the blueprint counterpart of FOmniAchievementService::Unlock.

Parameters

WorldContext	Reference to the world context.
Name	The API Name of the achievement to unlock.
ExtraData	Any additional data that may be necessary.
UnlockCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniAchievementUpdate* (null in error cases) are passed as parameters.