Navigation
API > API/Plugins > API/Plugins/OnlineServicesCommon > API/Plugins/OnlineServicesCommon/Online
Inheritance Hierarchy
- IOnlineComponent
- TOnlineComponent
- FAchievementsCommon
- FAchievementsEOSGS
- FAchievementsNull
- FAchievementsOSSAdapter
References
| Module | OnlineServicesCommon |
| Header | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/AchievementsCommon.h |
| Include | #include "Online/AchievementsCommon.h" |
Syntax
class FAchievementsCommon : public UE::Online::TOnlineComponent< IAchievements >
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TMap< FAccountId, FAchievementStateMap > | AchievementStates | |
 |
FAchievementsCommonConfig | Config | |
 |
TOnlineEventCallable< void(const FAchievementStateUpdated &)> | OnAchievementStateUpdatedEvent | |
 |
FOnlineEventDelegateHandle | StatEventHandle |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FAchievementsCommon
(
FOnlineServicesCommon& InServices |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
TOnlineResult< FDisplayAchievementUI > | DisplayAchievementUI
(
FDisplayAchievementUI::Params&& Params |
Launch the platform UI for a particular achievement |
 |
void | ExecuteUnlockRulesRelatedToStat
(
const FAccountId& AccountId, |
|
  |
TOnlineResult< FGetAchievementDefinition > | Gets an achievement definition by id. Requires first calling QueryAchievementDefinitions. | |
  |
TOnlineResult< FGetAchievementIds > | GetAchievementIds
(
FGetAchievementIds::Params&& Params |
Gets the achievement id's. Requires first calling QueryAchievementDefinitions. |
   |
TOnlineResult< FGetAchievementState > | GetAchievementState
(
FGetAchievementState::Params&& Params |
Gets the state of an achievement by id for the given player. |
  |
bool | IsUnlocked
(
const FAccountId& AccountId, |
|
 |
bool | MeetUnlockCondition
(
const FAchievementUnlockRule& AchievementUnlockRule, |
|
 |
void | OnAchievementStatesQueried
(
const FAccountId& AccountId |
|
  |
TOnlineEvent< void(const FAchievementStateUpdated &)> | Event triggered when a player's achievement state changes | |
  |
TOnlineAsyncOpHandle< FQueryAchievementDefinitions > | IAchievements. | |
  |
TOnlineAsyncOpHandle< FQueryAchievementStates > | QueryAchievementStates
(
FQueryAchievementStates::Params&& Params |
Query the state of all achievements for the given player. |
  |
TOnlineAsyncOpHandle< FUnlockAchievements > | UnlockAchievements
(
FUnlockAchievements::Params&& Params |
Manually unlock achievements Requires first calling QueryAchievementStates. |
 |
void | UnlockAchievementsByStats
(
const FStatsUpdated& StatsUpdated |
Overridden from TOnlineComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void |
Overridden from IOnlineComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | Initialize () |
TOnlineComponent. |
  |
void | Shutdown () |
Called right before the component is destroyed. It is not safe to reference any other components at this time. |
  |
void | UpdateConfig () |
Called whenever we need to reload data from config. |
Typedefs
| Name | Description |
|---|---|
| FAchievementStateMap | |
| Super |