IOnlineAchievements

[IOnlineAchievements](API\Plugins\OnlineSubsystem\Interfaces\IOnlineAchievements) - Interface class for achievements

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineAchievementsInterface.h

Include

#include "Interfaces/OnlineAchievementsInterface.h"

Syntax

class IOnlineAchievements

Remarks

IOnlineAchievements - Interface class for achievements

Variables

Name Description

Public variable

FOnAchievementU...

 

OnAchievementUnlockedDelegates

Delegate fired when an achievement on the server was unlocked

Destructors

Name Description

Public function Virtual

~IOnlineAchievements()

Functions

Name Description

Public function Virtual

FDelegateHan...

 

AddOnAchievementUnlockedDelegate_Handle

(
    const FOnAchievementUnlockedDelegat...
)

Public function Virtual

void

 

ClearOnAchievementUnlockedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnAchievementUnlockedDelegates

(
    void* Object
)

Public function

EOnlineCache...

 

GetCachedAchievement

(
    const FUniqueNetId& PlayerId,
    const FString& AchievementId,
    FOnlineAchievement& OutAchievement
)

Get an achievement object which was previously synced from the server

Public function

EOnlineCache...

 

GetCachedAchievementDescription

(
    const FString& AchievementId,
    FOnlineAchievementDesc& OutAchieve...
)

Get all the achievement description object for the specified achievement id

Public function

EOnlineCache...

 

GetCachedAchievements

(
    const FUniqueNetId& PlayerId,
    TArray< FOnlineAchievement >& OutA...
)

Get all the achievement objects for the specified player

Public function

void

 

QueryAchievementDescriptions

(
    const FUniqueNetId& PlayerId,
    const FOnQueryAchievementsCompleteD...
)

Read achievement descriptions from the server for displaying achievements in game

Public function

void

 

QueryAchievements

(
    const FUniqueNetId& PlayerId,
    const FOnQueryAchievementsCompleteD...
)

Read achievement ids and progress from the server You must use QueryAchievementDescriptions to get more information about the achievements

Public function

bool

 

ResetAchievements

(
    const FUniqueNetId& PlayerId
)

Resets achievements for a given player

Public function Virtual

void

 

TriggerOnAchievementUnlockedDelegates

(
    const FUniqueNetId& Param1,
    const FString& Param2
)

Public function

void

 

WriteAchievements

(
    const FUniqueNetId& PlayerId,
    FOnlineAchievementsWriteRef& Write...,
    const FOnAchievementsWrittenDelegat...
)

Write the achievements provided to the server

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss