Server Global API Reference

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

API List

API	Description
ServerSDK	Get the IServerSDK instance.
Battle	Get the IBattle instance (after calling IServerSDK::InitSDK).
Economy	Get the IEconomy instance (after calling IServerSDK::InitSDK).
Ect	Get the IEct instance (after calling IServerSDK::InitSDK).
Extension	Get the IExtension instance (after calling IServerSDK::InitSDK).
Friend	Get the IFriend instance (after calling IServerSDK::InitSDK).
Hosting	Get the IHosting instance (after calling IServerSDK::InitSDK).
HostingForking	Get the IHostingForking instance (after calling IServerSDK::InitSDK).
Party	Get the IParty instance (after calling IServerSDK::InitSDK).
PlayerBlobData	Get the IPlayerBlobData instance (after calling IServerSDK::InitSDK).
PlayerProfile	Get the IPlayerProfile instance (after calling IServerSDK::InitSDK).
Statistics	Get the IStatistics instance (after calling IServerSDK::InitSDK).
TitleConfigData	Get the ITitleConfigData instance (after calling IServerSDK::InitSDK).
TitleFile	Get the ITitleFile instance (after calling IServerSDK::InitSDK).
TitleRegionConfigData	Get the ITitleRegionConfigData instance (after calling IServerSDK::InitSDK).
Utility	Get the IUtility instance (after calling IServerSDK::InitSDK).

API Details

ServerSDK

Get the IServerSDK instance.

/**
 * Get the IServerSDK instance. 
 */
std::shared_ptr<IServerSDK> ServerSDK();

Parameters:

(No parameters)

Return: std::shared_ptr<IServerSDK>

Battle

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

/**
 * Get the IBattle instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IBattle> Battle();

Parameters:

(No parameters)

Return: std::shared_ptr<IBattle>

Economy

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

/**
 * Get the IEconomy instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IEconomy> Economy();

Parameters:

(No parameters)

Return: std::shared_ptr<IEconomy>

Ect

Get the IEct instance (after calling IServerSDK::InitSDK).

/**
 * Get the IEct instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IEct> Ect();

Parameters:

(No parameters)

Return: std::shared_ptr<IEct>

Extension

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

/**
 * Get the IExtension instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IExtension> Extension();

Parameters:

(No parameters)

Return: std::shared_ptr<IExtension>

Friend

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

/**
 * Get the IFriend instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IFriend> Friend();

Parameters:

(No parameters)

Return: std::shared_ptr<IFriend>

Hosting

Get the IHosting instance (after calling IServerSDK::InitSDK).

/**
 * Get the IHosting instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IHosting> Hosting();

Parameters:

(No parameters)

Return: std::shared_ptr<IHosting>

HostingForking

Get the IHostingForking instance (after calling IServerSDK::InitSDK).

/**
 * Get the IHostingForking instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IHostingForking> HostingForking();

Parameters:

(No parameters)

Return: std::shared_ptr<IHostingForking>

Party

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

/**
 * Get the IParty instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IParty> Party();

Parameters:

(No parameters)

Return: std::shared_ptr<IParty>

PlayerBlobData

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

/**
 * Get the IPlayerBlobData instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IPlayerBlobData> PlayerBlobData();

Parameters:

(No parameters)

Return: std::shared_ptr<IPlayerBlobData>

PlayerProfile

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

/**
 * Get the IPlayerProfile instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IPlayerProfile> PlayerProfile();

Parameters:

(No parameters)

Return: std::shared_ptr<IPlayerProfile>

Statistics

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

/**
 * Get the IStatistics instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IStatistics> Statistics();

Parameters:

(No parameters)

Return: std::shared_ptr<IStatistics>

TitleConfigData

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

/**
 * Get the ITitleConfigData instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<ITitleConfigData> TitleConfigData();

Parameters:

(No parameters)

Return: std::shared_ptr<ITitleConfigData>

TitleFile

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

/**
 * Get the ITitleFile instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<ITitleFile> TitleFile();

Parameters:

(No parameters)

Return: std::shared_ptr<ITitleFile>

TitleRegionConfigData

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

/**
 * Get the ITitleRegionConfigData instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<ITitleRegionConfigData> TitleRegionConfigData();

Parameters:

(No parameters)

Return: std::shared_ptr<ITitleRegionConfigData>

Utility

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

/**
 * Get the IUtility instance (after calling IServerSDK::InitSDK). 
 */
std::shared_ptr<IUtility> Utility();

Parameters:

(No parameters)

Return: std::shared_ptr<IUtility>