Client Global API Reference

Global accessors for PGOS Client SDK interfaces. See individual *_i.hpp files for details. You should not cache the results of these accessors: will be invalid when the IClientSDK is destroyed.

API List

API	Description
ClientSDK	Get the IClientSDK instance.
Battle	Get the IBattle instance (after calling IClientSDK::InitSDK).
Blocklist	Get the IBlocklist instance (after calling IClientSDK::InitSDK).
Economy	Get the IEconomy instance (after calling IClientSDK::InitSDK).
Extension	Get the IExtension instance (after calling IClientSDK::InitSDK).
FakeAccount	Get the IFakeAccount instance (after calling IClientSDK::InitSDK).
Friend	Get the IFriend instance (after calling IClientSDK::InitSDK).
Goal	Get the IGoal instance (after calling IClientSDK::InitSDK).
Group	Get the IGroup instance (after calling IClientSDK::InitSDK).
InstantChat	Get the IInstantChat instance (after calling IClientSDK::InitSDK).
Leaderboard	Get the ILeaderboard instance (after calling IClientSDK::InitSDK).
Lobby	Get the ILobby instance (after calling IClientSDK::InitSDK).
Mail	Get the IMail instance (after calling IClientSDK::InitSDK).
Matchmaking	Get the IMatchmaking instance (after calling IClientSDK::InitSDK).
Metric	Get the IMetric instance (after calling IClientSDK::InitSDK).
P2PBattle	Get the IP2PBattle instance (after calling IClientSDK::InitSDK).
P2PConnection	Get the IP2PConnection instance (after calling IClientSDK::InitSDK).
Party	Get the IParty instance (after calling IClientSDK::InitSDK).
PersonalChat	Get the IPersonalChat instance (after calling IClientSDK::InitSDK).
PlayerAuth	Get the IPlayerAuth instance (after calling IClientSDK::InitSDK).
PlayerBlobData	Get the IPlayerBlobData instance (after calling IClientSDK::InitSDK).
PlayerProfile	Get the IPlayerProfile instance (after calling IClientSDK::InitSDK).
PublicChat	Get the IPublicChat instance (after calling IClientSDK::InitSDK).
Settings	Get the ISettings instance (after calling IClientSDK::InitSDK).
Statistics	Get the IStatistics instance (after calling IClientSDK::InitSDK).
System	Get the ISystem instance (after calling IClientSDK::InitSDK).
TitleConfigData	Get the ITitleConfigData instance (after calling IClientSDK::InitSDK).
TitleFile	Get the ITitleFile instance (after calling IClientSDK::InitSDK).
TitleRegionConfigData	Get the ITitleRegionConfigData instance (after calling IClientSDK::InitSDK).
Utility	Get the IUtility instance (after calling IClientSDK::InitSDK).
Voice	Get the IVoice instance (after calling IClientSDK::InitSDK).
World	Get the IWorld instance (after calling IClientSDK::InitSDK).

API Details

ClientSDK

Get the IClientSDK instance.

/**
 * Get the IClientSDK instance. 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IClientSDK> ClientSDK(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IClientSDK>

Battle

Get the IBattle instance (after calling IClientSDK::InitSDK).

/**
 * Get the IBattle instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IBattle> Battle(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IBattle>

Blocklist

Get the IBlocklist instance (after calling IClientSDK::InitSDK).

/**
 * Get the IBlocklist instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IBlocklist> Blocklist(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IBlocklist>

Economy

Get the IEconomy instance (after calling IClientSDK::InitSDK).

/**
 * Get the IEconomy instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IEconomy> Economy(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IEconomy>

Extension

Get the IExtension instance (after calling IClientSDK::InitSDK).

/**
 * Get the IExtension instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IExtension> Extension(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IExtension>

FakeAccount

Get the IFakeAccount instance (after calling IClientSDK::InitSDK).

/**
 * Get the IFakeAccount instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IFakeAccount> FakeAccount(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IFakeAccount>

Friend

Get the IFriend instance (after calling IClientSDK::InitSDK).

/**
 * Get the IFriend instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IFriend> Friend(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IFriend>

Goal

Get the IGoal instance (after calling IClientSDK::InitSDK).

/**
 * Get the IGoal instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IGoal> Goal(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IGoal>

Group

Get the IGroup instance (after calling IClientSDK::InitSDK).

/**
 * Get the IGroup instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IGroup> Group(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IGroup>

InstantChat

Get the IInstantChat instance (after calling IClientSDK::InitSDK).

/**
 * Get the IInstantChat instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IInstantChat> InstantChat(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IInstantChat>

Leaderboard

Get the ILeaderboard instance (after calling IClientSDK::InitSDK).

/**
 * Get the ILeaderboard instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ILeaderboard> Leaderboard(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ILeaderboard>

Lobby

Get the ILobby instance (after calling IClientSDK::InitSDK).

/**
 * Get the ILobby instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ILobby> Lobby(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ILobby>

Mail

Get the IMail instance (after calling IClientSDK::InitSDK).

/**
 * Get the IMail instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IMail> Mail(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IMail>

Matchmaking

Get the IMatchmaking instance (after calling IClientSDK::InitSDK).

/**
 * Get the IMatchmaking instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IMatchmaking> Matchmaking(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IMatchmaking>

Metric

Get the IMetric instance (after calling IClientSDK::InitSDK).

/**
 * Get the IMetric instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IMetric> Metric(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IMetric>

P2PBattle

Get the IP2PBattle instance (after calling IClientSDK::InitSDK).

/**
 * Get the IP2PBattle instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IP2PBattle> P2PBattle(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IP2PBattle>

P2PConnection

Get the IP2PConnection instance (after calling IClientSDK::InitSDK).

/**
 * Get the IP2PConnection instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IP2PConnection> P2PConnection(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IP2PConnection>

Party

Get the IParty instance (after calling IClientSDK::InitSDK).

/**
 * Get the IParty instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IParty> Party(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IParty>

PersonalChat

Get the IPersonalChat instance (after calling IClientSDK::InitSDK).

/**
 * Get the IPersonalChat instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IPersonalChat> PersonalChat(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IPersonalChat>

PlayerAuth

Get the IPlayerAuth instance (after calling IClientSDK::InitSDK).

/**
 * Get the IPlayerAuth instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IPlayerAuth> PlayerAuth(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IPlayerAuth>

PlayerBlobData

Get the IPlayerBlobData instance (after calling IClientSDK::InitSDK).

/**
 * Get the IPlayerBlobData instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IPlayerBlobData> PlayerBlobData(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IPlayerBlobData>

PlayerProfile

Get the IPlayerProfile instance (after calling IClientSDK::InitSDK).

/**
 * Get the IPlayerProfile instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IPlayerProfile> PlayerProfile(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IPlayerProfile>

PublicChat

Get the IPublicChat instance (after calling IClientSDK::InitSDK).

/**
 * Get the IPublicChat instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IPublicChat> PublicChat(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IPublicChat>

Settings

Get the ISettings instance (after calling IClientSDK::InitSDK).

/**
 * Get the ISettings instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ISettings> Settings(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ISettings>

Statistics

Get the IStatistics instance (after calling IClientSDK::InitSDK).

/**
 * Get the IStatistics instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IStatistics> Statistics(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IStatistics>

System

Get the ISystem instance (after calling IClientSDK::InitSDK).

/**
 * Get the ISystem instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ISystem> System(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ISystem>

TitleConfigData

Get the ITitleConfigData instance (after calling IClientSDK::InitSDK).

/**
 * Get the ITitleConfigData instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ITitleConfigData> TitleConfigData(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ITitleConfigData>

TitleFile

Get the ITitleFile instance (after calling IClientSDK::InitSDK).

/**
 * Get the ITitleFile instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ITitleFile> TitleFile(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ITitleFile>

TitleRegionConfigData

Get the ITitleRegionConfigData instance (after calling IClientSDK::InitSDK).

/**
 * Get the ITitleRegionConfigData instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<ITitleRegionConfigData> TitleRegionConfigData(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<ITitleRegionConfigData>

Utility

Get the IUtility instance (after calling IClientSDK::InitSDK).

/**
 * Get the IUtility instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IUtility> Utility(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IUtility>

Voice

Get the IVoice instance (after calling IClientSDK::InitSDK).

/**
 * Get the IVoice instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IVoice> Voice(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IVoice>

World

Get the IWorld instance (after calling IClientSDK::InitSDK).

/**
 * Get the IWorld instance (after calling IClientSDK::InitSDK). 
 * 
 * @param sdk_inst_idx Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.
 */
std::shared_ptr<IWorld> World(
    int32_t sdk_inst_idx = 0);

Parameters:

Param	Type	Description
sdk_inst_idx	int32_t	Ignore the 'sdk_inst_idx' parameter if you just need 1 sdk instance in the client process.

Return: std::shared_ptr<IWorld>