Server 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.
CreatePGOSForkingProcess	Create and Destroy PGOS in the MAIN thread.
DestroyPGOS	Create and Destroy PGOS in the MAIN thread.
GetServerServerSDKAPI	ServerSDK interface
GetServerBattleAPI	Battle interface
GetServerEconomyAPI	Economy interface
GetServerEctAPI	Ect interface
GetServerExtensionAPI	Extension interface
GetServerFriendAPI	Friend interface
GetServerHostingAPI	Hosting interface
GetServerHostingForkingAPI	HostingForking interface
GetServerPartyAPI	Party interface
GetServerPlayerBlobDataAPI	PlayerBlobData interface
GetServerPlayerProfileAPI	PlayerProfile interface
GetServerStatisticsAPI	Statistics interface
GetServerTitleConfigDataAPI	TitleConfigData interface
GetServerTitleFileAPI	TitleFile interface
GetServerTitleRegionConfigDataAPI	TitleRegionConfigData interface
GetServerUtilityAPI	Utility 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

CreatePGOSForkingProcess

Create and Destroy PGOS in the MAIN thread.

/**
 * Create and Destroy PGOS in the MAIN thread.
 */
virtual void CreatePGOSForkingProcess() = 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

GetServerServerSDKAPI

ServerSDK interface

/**
 * ServerSDK interface
 */
virtual PgosServerServerSDKPtr GetServerServerSDKAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerServerSDKPtr

GetServerBattleAPI

Battle interface

/**
 * Battle interface
 */
virtual PgosServerBattlePtr GetServerBattleAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerBattlePtr

GetServerEconomyAPI

Economy interface

/**
 * Economy interface
 */
virtual PgosServerEconomyPtr GetServerEconomyAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerEconomyPtr

GetServerEctAPI

Ect interface

/**
 * Ect interface
 */
virtual PgosServerEctPtr GetServerEctAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerEctPtr

GetServerExtensionAPI

Extension interface

/**
 * Extension interface
 */
virtual PgosServerExtensionPtr GetServerExtensionAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerExtensionPtr

GetServerFriendAPI

Friend interface

/**
 * Friend interface
 */
virtual PgosServerFriendPtr GetServerFriendAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerFriendPtr

GetServerHostingAPI

Hosting interface

/**
 * Hosting interface
 */
virtual PgosServerHostingPtr GetServerHostingAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerHostingPtr

GetServerHostingForkingAPI

HostingForking interface

/**
 * HostingForking interface
 */
virtual PgosServerHostingForkingPtr GetServerHostingForkingAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerHostingForkingPtr

GetServerPartyAPI

Party interface

/**
 * Party interface
 */
virtual PgosServerPartyPtr GetServerPartyAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerPartyPtr

GetServerPlayerBlobDataAPI

PlayerBlobData interface

/**
 * PlayerBlobData interface
 */
virtual PgosServerPlayerBlobDataPtr GetServerPlayerBlobDataAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerPlayerBlobDataPtr

GetServerPlayerProfileAPI

PlayerProfile interface

/**
 * PlayerProfile interface
 */
virtual PgosServerPlayerProfilePtr GetServerPlayerProfileAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerPlayerProfilePtr

GetServerStatisticsAPI

Statistics interface

/**
 * Statistics interface
 */
virtual PgosServerStatisticsPtr GetServerStatisticsAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerStatisticsPtr

GetServerTitleConfigDataAPI

TitleConfigData interface

/**
 * TitleConfigData interface
 */
virtual PgosServerTitleConfigDataPtr GetServerTitleConfigDataAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerTitleConfigDataPtr

GetServerTitleFileAPI

TitleFile interface

/**
 * TitleFile interface
 */
virtual PgosServerTitleFilePtr GetServerTitleFileAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerTitleFilePtr

GetServerTitleRegionConfigDataAPI

TitleRegionConfigData interface

/**
 * TitleRegionConfigData interface
 */
virtual PgosServerTitleRegionConfigDataPtr GetServerTitleRegionConfigDataAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerTitleRegionConfigDataPtr

GetServerUtilityAPI

Utility interface

/**
 * Utility interface
 */
virtual PgosServerUtilityPtr GetServerUtilityAPI() const = 0;

Parameters:

(No parameters)

Return: PgosServerUtilityPtr

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&