Client PgosSDKCpp API Reference
Global accessors for PGOS SDK interfaces. See individual Pgos***API.h files for details.
API List
| API | Description |
|---|---|
| Get | Get the PgosSDKCpp instance |
| CreatePGOS | Create and Destroy PGOS in the MAIN thread. |
| DestroyPGOS | Create and Destroy PGOS in the MAIN thread. |
| GetClientClientSDKAPI | ClientSDK interface |
| GetClientBattleAPI | Battle interface |
| GetClientBlocklistAPI | Blocklist interface |
| GetClientEconomyAPI | Economy interface |
| GetClientExtensionAPI | Extension interface |
| GetClientFakeAccountAPI | FakeAccount interface |
| GetClientFriendAPI | Friend interface |
| GetClientGoalAPI | Goal interface |
| GetClientGroupAPI | Group interface |
| GetClientInstantChatAPI | InstantChat interface |
| GetClientLeaderboardAPI | Leaderboard interface |
| GetClientLobbyAPI | Lobby interface |
| GetClientMailAPI | Mail interface |
| GetClientMatchmakingAPI | Matchmaking interface |
| GetClientMetricAPI | Metric interface |
| GetClientMidasGlobalAPI | MidasGlobal interface |
| GetClientP2PBattleAPI | P2PBattle interface |
| GetClientP2PConnectionAPI | P2PConnection interface |
| GetClientPartyAPI | Party interface |
| GetClientPersonalChatAPI | PersonalChat interface |
| GetClientPlayerAuthAPI | PlayerAuth interface |
| GetClientPlayerBlobDataAPI | PlayerBlobData interface |
| GetClientPlayerProfileAPI | PlayerProfile interface |
| GetClientPublicChatAPI | PublicChat interface |
| GetClientSettingsAPI | Settings interface |
| GetClientStatisticsAPI | Statistics interface |
| GetClientSystemAPI | System interface |
| GetClientTitleConfigDataAPI | TitleConfigData interface |
| GetClientTitleFileAPI | TitleFile interface |
| GetClientTitleRegionConfigDataAPI | TitleRegionConfigData interface |
| GetClientUtilityAPI | Utility interface |
| GetClientVoiceAPI | Voice interface |
| GetClientWorldAPI | World interface |
| GetPreCreateSettings | PreCreateSettings: Optional extra settings that need to be set before calling CreatePGOS/CreatePGOSForkingProcess, e.g. custom PGOS log directory. |
API Details
Get
Get the PgosSDKCpp instance
/**
* Get the PgosSDKCpp instance
*
* @param LocalPlayer Specify the local player that the PgosSDK instance should be associated with. If you are obtaining the SDK instance for the game server, you can ignore this parameter. If the game client PgosSDK instance mode is set to 'Singleton' (default mode), you can ignore this parameter. If the game client PgosSDK instance mode is set to 'LocalPlayerBased' and you are obtaining the SDK instance for the game client, make sure to pass in a valid local player. To view the game client PgosSDK instance mode, navigate in Editor: Settings -> Project Settings -> Plugins -> PgosSDK -> Client Settings -> ClientSDKInstanceMode. For more detail about PgosSDK instance management, you can refer to: https://pgos.intlgame.com/pgosdoc/manual/getting_started/unreal/client_sdk_instance_mode.html
*/
static IPgosSDKCpp& Get(ULocalPlayer* LocalPlayer = nullptr);
Parameters:
| Param | Type | Description |
|---|---|---|
| LocalPlayer | ULocalPlayer* | Specify the local player that the PgosSDK instance should be associated with. If you are obtaining the SDK instance for the game server, you can ignore this parameter. If the game client PgosSDK instance mode is set to 'Singleton' (default mode), you can ignore this parameter. If the game client PgosSDK instance mode is set to 'LocalPlayerBased' and you are obtaining the SDK instance for the game client, make sure to pass in a valid local player. To view the game client PgosSDK instance mode, navigate in Editor: Settings -> Project Settings -> Plugins -> PgosSDK -> Client Settings -> ClientSDKInstanceMode. For more detail about PgosSDK instance management, you can refer to: https://pgos.intlgame.com/pgosdoc/manual/getting_started/unreal/client_sdk_instance_mode.html |
Return: IPgosSDKCpp&
CreatePGOS
Create and Destroy PGOS in the MAIN thread.
/**
* Create and Destroy PGOS in the MAIN thread.
*/
virtual void CreatePGOS() = 0;
Parameters:
(No parameters)
Return: void
DestroyPGOS
Create and Destroy PGOS in the MAIN thread.
/**
* Create and Destroy PGOS in the MAIN thread.
*/
virtual void DestroyPGOS() = 0;
Parameters:
(No parameters)
Return: void
GetClientClientSDKAPI
ClientSDK interface
/**
* ClientSDK interface
*/
virtual PgosClientClientSDKPtr GetClientClientSDKAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientClientSDKPtr
GetClientBattleAPI
Battle interface
/**
* Battle interface
*/
virtual PgosClientBattlePtr GetClientBattleAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientBattlePtr
GetClientBlocklistAPI
Blocklist interface
/**
* Blocklist interface
*/
virtual PgosClientBlocklistPtr GetClientBlocklistAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientBlocklistPtr
GetClientEconomyAPI
Economy interface
/**
* Economy interface
*/
virtual PgosClientEconomyPtr GetClientEconomyAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientEconomyPtr
GetClientExtensionAPI
Extension interface
/**
* Extension interface
*/
virtual PgosClientExtensionPtr GetClientExtensionAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientExtensionPtr
GetClientFakeAccountAPI
FakeAccount interface
/**
* FakeAccount interface
*/
virtual PgosClientFakeAccountPtr GetClientFakeAccountAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientFakeAccountPtr
GetClientFriendAPI
Friend interface
/**
* Friend interface
*/
virtual PgosClientFriendPtr GetClientFriendAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientFriendPtr
GetClientGoalAPI
Goal interface
/**
* Goal interface
*/
virtual PgosClientGoalPtr GetClientGoalAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientGoalPtr
GetClientGroupAPI
Group interface
/**
* Group interface
*/
virtual PgosClientGroupPtr GetClientGroupAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientGroupPtr
GetClientInstantChatAPI
InstantChat interface
/**
* InstantChat interface
*/
virtual PgosClientInstantChatPtr GetClientInstantChatAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientInstantChatPtr
GetClientLeaderboardAPI
Leaderboard interface
/**
* Leaderboard interface
*/
virtual PgosClientLeaderboardPtr GetClientLeaderboardAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientLeaderboardPtr
GetClientLobbyAPI
Lobby interface
/**
* Lobby interface
*/
virtual PgosClientLobbyPtr GetClientLobbyAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientLobbyPtr
GetClientMailAPI
Mail interface
/**
* Mail interface
*/
virtual PgosClientMailPtr GetClientMailAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientMailPtr
GetClientMatchmakingAPI
Matchmaking interface
/**
* Matchmaking interface
*/
virtual PgosClientMatchmakingPtr GetClientMatchmakingAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientMatchmakingPtr
GetClientMetricAPI
Metric interface
/**
* Metric interface
*/
virtual PgosClientMetricPtr GetClientMetricAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientMetricPtr
GetClientMidasGlobalAPI
MidasGlobal interface
/**
* MidasGlobal interface
*/
virtual PgosClientMidasGlobalPtr GetClientMidasGlobalAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientMidasGlobalPtr
GetClientP2PBattleAPI
P2PBattle interface
/**
* P2PBattle interface
*/
virtual PgosClientP2PBattlePtr GetClientP2PBattleAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientP2PBattlePtr
GetClientP2PConnectionAPI
P2PConnection interface
/**
* P2PConnection interface
*/
virtual PgosClientP2PConnectionPtr GetClientP2PConnectionAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientP2PConnectionPtr
GetClientPartyAPI
Party interface
/**
* Party interface
*/
virtual PgosClientPartyPtr GetClientPartyAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientPartyPtr
GetClientPersonalChatAPI
PersonalChat interface
/**
* PersonalChat interface
*/
virtual PgosClientPersonalChatPtr GetClientPersonalChatAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientPersonalChatPtr
GetClientPlayerAuthAPI
PlayerAuth interface
/**
* PlayerAuth interface
*/
virtual PgosClientPlayerAuthPtr GetClientPlayerAuthAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientPlayerAuthPtr
GetClientPlayerBlobDataAPI
PlayerBlobData interface
/**
* PlayerBlobData interface
*/
virtual PgosClientPlayerBlobDataPtr GetClientPlayerBlobDataAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientPlayerBlobDataPtr
GetClientPlayerProfileAPI
PlayerProfile interface
/**
* PlayerProfile interface
*/
virtual PgosClientPlayerProfilePtr GetClientPlayerProfileAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientPlayerProfilePtr
GetClientPublicChatAPI
PublicChat interface
/**
* PublicChat interface
*/
virtual PgosClientPublicChatPtr GetClientPublicChatAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientPublicChatPtr
GetClientSettingsAPI
Settings interface
/**
* Settings interface
*/
virtual PgosClientSettingsPtr GetClientSettingsAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientSettingsPtr
GetClientStatisticsAPI
Statistics interface
/**
* Statistics interface
*/
virtual PgosClientStatisticsPtr GetClientStatisticsAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientStatisticsPtr
GetClientSystemAPI
System interface
/**
* System interface
*/
virtual PgosClientSystemPtr GetClientSystemAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientSystemPtr
GetClientTitleConfigDataAPI
TitleConfigData interface
/**
* TitleConfigData interface
*/
virtual PgosClientTitleConfigDataPtr GetClientTitleConfigDataAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientTitleConfigDataPtr
GetClientTitleFileAPI
TitleFile interface
/**
* TitleFile interface
*/
virtual PgosClientTitleFilePtr GetClientTitleFileAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientTitleFilePtr
GetClientTitleRegionConfigDataAPI
TitleRegionConfigData interface
/**
* TitleRegionConfigData interface
*/
virtual PgosClientTitleRegionConfigDataPtr GetClientTitleRegionConfigDataAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientTitleRegionConfigDataPtr
GetClientUtilityAPI
Utility interface
/**
* Utility interface
*/
virtual PgosClientUtilityPtr GetClientUtilityAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientUtilityPtr
GetClientVoiceAPI
Voice interface
/**
* Voice interface
*/
virtual PgosClientVoicePtr GetClientVoiceAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientVoicePtr
GetClientWorldAPI
World interface
/**
* World interface
*/
virtual PgosClientWorldPtr GetClientWorldAPI() const = 0;
Parameters:
(No parameters)
Return: PgosClientWorldPtr
GetPreCreateSettings
PreCreateSettings: Optional extra settings that need to be set before calling CreatePGOS/CreatePGOSForkingProcess, e.g. custom PGOS log directory.
/**
* PreCreateSettings: Optional extra settings that need to be set before calling CreatePGOS/CreatePGOSForkingProcess, e.g. custom PGOS log directory.
*/
static FPgosPreCreateSettings& GetPreCreateSettings();
Parameters:
(No parameters)
Return: FPgosPreCreateSettings&