Base Data Models

Enums

EPgosAccountProvider

Game integrated account service provider.

enum class EPgosAccountProvider : uint8

member	value	description
FAS	0	Fake account service provided by PGOS.
INTL	1	Account service provided by Proxima for overseas games.
MSDK	2	Account service provided by Tencent for China mainland games.
WeGame	3	Account service provided by WeGame.
PlayFab	4	Account service provided by PlayFab.
Steam	5	Account service provided by Steam.
Epic	6	Account service provided by Epic(EOS), only epicgames identity is supported.
XboxLive	7	Account service provided by XboxLive.
PlayStationNetwork	8	Account service provided by PlayStationNetwork.
Nintendo	9	Account service provided by Nintendo.
JWT	10	Custom JWT-based authentication using your own identity provider.

EPgosClientOS

The operating system the game client runs on.

enum class EPgosClientOS : uint8

member	value	description
Unknown	0	Unknown.
Linux	1	Linux.
Windows	2	Windows.
Mac	3	MacOS.
Android	4	Android.
IOS	5	IOS.
Xbox	6	XBOX.
PlayStation	7	PSN.
Switch	8	Switch.
Web	9	Run on web browser.

EPgosPlayerSessionEvt

Purpose: define player-session event in its lifetime.

enum class EPgosPlayerSessionEvt : uint8

member	value	description
Dummy	0	unknown event.
SessionExpired_NetworkAbnormal	1	triggered when the network is abnormal. It is recommended that game clients silently call 'ReLoginPGOS' to create a new player session to regain access to PGOS services. If the result of 'ReLoginPGOS' still fails, then notify the player to check the local network environment.
SessionExpired_TokenExpired	2	triggered when the PGOS PLAYER TOKEN expired. This usually happens when: the game client loses the network for a long time (for example, the app enters the background mode on the mobile device), and then regains the network (the app enters the foreground mode) and reconnects with PGOS. It is recommended that game clients silently call 'ReLoginPGOS' to create a new player session to regain access to PGOS services. If the result of 'ReLoginPGOS' API still fails, then notify the player to re-login using the account service.
SessionExpired_KickoutByGame	3	triggered when the game behavior kicks the player out (by the virtual_server API: KickOutPlayer()). it is recommended to notify the player to check the account status.
SessionExpired_KickoutByBan	4	triggered when the player is banned by the virtual_server API: BanPlayer(kickout=true). it is recommended to notify the player to check the account status.
SessionExpired_KickoutByAnotherLogin	5	triggered when the account performed another login (maybe on another device). it is recommended to notify the player to check the account status.
SessionExpired_KickoutByTitleRegionClosed	6	triggered when the title region is closed.
SessionExpired_KickoutByAccountCanceled	7	triggered when the account is cancelled. it is recommended to notify the player to check the account status.
SessionStart	8	triggered when a player session starts successfully after LoginPGOS is called.
SessionEnd	9	triggered when player-session ended.

EPgosAcceptedStatus

Player response to the proposed battle.

enum class EPgosAcceptedStatus : uint8

member	value	description
Dummy	0	Dummy. Player did not submit the confirmation.
Accepted	1	Player has accepted the proposed battle.
Rejected	2	Player has rejected the proposed battle.

EPgosBattleSourceType

Battle source type defines.

enum class EPgosBattleSourceType : uint8

member	value	description
None	0	None.
Matchmaking	1	Battle generated by matchmaking service.
Lobby	2	Battle generated by lobby service.
Standalone	3	Battle generated by game server.
World	4	Battle generated by world service.

EPgosInGameItemType

InGameItem type defines

enum class EPgosInGameItemType : uint8

member	value	description
Dummy	0	None
Normal	1	It is the most basic item in in-game item, which would not own any 'content item'.
Bundle	2	It represents a group of in-game items, which will not be instantiated into the player inventory.
Container	3	It contains a group of in-game items, which can be instantiated into the player inventory.

EPgosItemInstanceStatus

InGameItem type defines

enum class EPgosItemInstanceStatus : uint8

member	value	description
Dummy	0	None
Available	1	The item instance can be used.
Expired	2	The item instance has expired and can't be used.

EPgosKVDataType

Value types of KVData

enum class EPgosKVDataType : uint8

member	value	description
String	0	String value.
Integer	1	Integer number value: can hold Int32/Int64 numbers.
Float	2	Floating-point number value: can hold float/double numbers.

EPgosGameProcessType

Type of game process.

enum class EPgosGameProcessType : uint8

member	value	description
Client	0	A game client process.
Normal	1	Game server processes that can hold battle sessions.
ForkingProcess	2	A ForkingProcess is a special server process which will be forked to child that can hold battle sessions.
ForkedChild	3	A process that was forked from a ForkingProcess game server. ForkedChild should be able to hold a battle session.

EPgosAggregateType

Method for updating statistics items.

enum class EPgosAggregateType : uint8

member	value	description
Overwrite	0	Overwrite with the latest value.
Sum	1	Sum the value to the exist value.
Maximum	2	Overwrite with the maximum value.
Minimum	3	Overwrite with the minimum value.

EPgosClientSDKInstanceMode

PgosSDK Instance mode running in the Game Client.

enum class EPgosClientSDKInstanceMode : uint8

member	value	description
Singleton	0	The PgosSDK instance is a singleton instance in the game client.
LocalPlayerBased	1	The number of PgosSDK instances in the game client is based on the number of local players, with each local player having their own PgosSDK instance.

EPgosDataCenterName

Enumerate all possible names of the data center in PGOS DS Hosting.

enum class EPgosDataCenterName : FString

member	value	description
TCloudGuangzhou	tcloud_guangzhou	The name of TCloud data center in Guangzhou.
TCloudShanghai	tcloud_shanghai	The name of TCloud data center in Shanghai.
TCloudSingapore	tcloud_singapore	The name of TCloud data center in Singapore.
TCloudTokyo	tcloud_tokyo	The name of TCloud data center in Tokyo.
TCloudMumbai	tcloud_mumbai	The name of TCloud data center in Mumbai.
TCloudFrankfurt	tcloud_frankfurt	The name of TCloud data center in Frankfurt.
TCloudVirginia	tcloud_virginia	The name of TCloud data center in Virginia.
TCloudSiliconvalley	tcloud_siliconvalley	The name of TCloud data center in Siliconvalley.
TCloudSaopaulo	tcloud_saopaulo	The name of TCloud data center in Saopaulo.
AWSSingapore	aws_singapore	The name of AWS data center in Singapore.
AWSSydney	aws_sydney	The name of AWS data center in Sydney.
AWSMumbai	aws_mumbai	The name of AWS data center in Mumbai.
AWSFrankfurt	aws_frankfurt	The name of AWS data center in Frankfurt.
AWSOregon	aws_oregon	The name of AWS data center in Oregon.
BMFrankfurt	baremetal_frankfurt	The name of bare metal data center in Frankfurt.

EPgosCurrencyType

enum class EPgosCurrencyType : uint8

member	value	description
Dummy	0	Reserved value, not used.
PGOSVC	1	Virtual currency managed by PGOS.
MidasGlobalToken	2	Virtual currency(so called Token by Midas) managed by Midas Global.

EPgosBooleanFilter

enum class EPgosBooleanFilter : uint8

member	value	description
BooleanAny	0	No filter.
BooleanTrue	1	True filter.
BooleanFalse	2	False filter.

EPgosFilterComparisonOperator

enum class EPgosFilterComparisonOperator : uint8

member	value	description
FilterComparisonOperatorEqual	0	Equal filter.
FilterComparisonOperatorNotEqual	1	Not equal filter.

Structs

FPgosMidasGlobalMetaData

Meta data for Midas Global.

struct FPgosMidasGlobalMetaData

field	type	description
app_id	FString	Apply Offer id of a Midas payment scenario.
role_id	FString	Midas Role ID. Each Role ID has its own independent Midas token balance. Note: The game client needs to provide the role ID only when the is_role_id_mapped parameter obtained through the GetMidasGlobalAddonInfo interface is false. Otherwise, this parameter will be ignored.
platform	FString	Platform need by midas payment scenario. Must be one of: ANDROID, IOS, WINDOWS(including epic, steam, midaspay), GAME_CONSOLE(including switch, xbox, play station)

FPgosPayPlatformData

struct FPgosPayPlatformData

field	type	description
midas_global	FPgosMidasGlobalMetaData

FPgosResult

Common result for PGOS API calls.

struct FPgosResult

field	type	description
err_code	int32	error code, view pgos_error.h/PgosErrorCode.h for details.
msg	FString	error message, view pgos_error.h/PgosErrorCode.h for details.

FPgosInitSdkParams

Request parameters for init sdk.

struct FPgosInitSdkParams

field	type	description
res_dir	FString	Directory path for PGOS resource files (pgos_config.ini/pgos_server_config.ini, etc.), encoded in ANSI.
log_dir	FString	Directory path for PGOS log files, encoded in ANSI.
cache_dir	FString	Directory path for PGOS cache files, encoded in ANSI.

FPgosKVDataValue

Value of KVData, with a bunch of useful constructors and operator overloaded functions.

struct FPgosKVDataValue

field	type	description
value	FString	Value data: Please access with operators or As* functions.
type	EPgosKVDataType	Value type: String/Integer/Float.

FPgosOnePlayerKVData

A kvdata item for a specified key of a specified player.

struct FPgosOnePlayerKVData

field	type	description
player_id	FString	The player who owns the kvdata.
key	FString	The query key.
value	FPgosKVDataValue	Value corresponding to key.

FPgosKVDataGroup

A set of kvdata items.

struct FPgosKVDataGroup

field	type	description
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.

FPgosKVDataGroupWithVer

A set of kvdata items.

struct FPgosKVDataGroupWithVer

field	type	description
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.
version	int32	The player-wide version of the versioned kvdata

FPgosKVDataGroupWithVerAndFails

A set of kvdata items.

struct FPgosKVDataGroupWithVerAndFails

field	type	description
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.
version	int32	The player-wide version of the versioned kvdata
failed_keys	TMap<FString, FPgosResult>	KVData items that failed to query, key: item key, value: failed reason.

FPgosPlayerKVDataGroup

A set of kvdata items for a specified player, including the keys that failed to be retrieved.

struct FPgosPlayerKVDataGroup

field	type	description
player_id	FString	The player who owns the kvdata.
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.

FPgosPlayerKVDataGroupWithVer

A set of kvdata items for a specified player, including the keys that failed to be retrieved.

struct FPgosPlayerKVDataGroupWithVer

field	type	description
player_id	FString	The player who owns the kvdata.
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.
version	int32	The player-wide version of the versioned kvdata

FPgosPlayerKVDataGroupWithFails

A set of kvdata items for a specified player, including the keys that failed to be retrieved.

struct FPgosPlayerKVDataGroupWithFails

field	type	description
player_id	FString	The player who owns the kvdata.
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.
failed_keys	TMap<FString, FPgosResult>	KVData items that failed to query, key: item key, value: failed reason.

FPgosPlayerKVDataGroupWithVerAndFails

A set of kvdata items for a specified player, including the keys that failed to be retrieved.

struct FPgosPlayerKVDataGroupWithVerAndFails

field	type	description
player_id	FString	The player who owns the kvdata.
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.
version	int32	The player-wide version of the versioned kvdata
failed_keys	TMap<FString, FPgosResult>	KVData items that failed to query, key: item key, value: failed reason.

FPgosKVDataGroupWithFails

A set of kvdata items, including the keys that failed to be retrieved.

struct FPgosKVDataGroupWithFails

field	type	description
kvdata	TMap<FString, FPgosKVDataValue>	KVData items, key: item key, value: item value.
failed_keys	TMap<FString, FPgosResult>	KVData items that failed to query, key: item key, value: failed reason.

FPgosBatchPlayerKVDataGroup

Batch players' respective kvdata items, including players who completely failed to retrieve.

struct FPgosBatchPlayerKVDataGroup

field	type	description
data	TMap<FString, FPgosKVDataGroup>	New value of the updated kvdatas, key: player_id, value: player's new kvdata.
failed_players	TMap<FString, FPgosResult>	Players who totally failed, key: player_id, value: failed reason.

FPgosBatchPlayerKVDataGroupWithFails

Batch players' respective kvdata items, including players who completely failed to retrieve and keys that failed to retrieve for players who partially succeeded.

struct FPgosBatchPlayerKVDataGroupWithFails

field	type	description
data	TMap<FString, FPgosKVDataGroupWithFails>	KVData and fails of the players, key: player_id, value: the player's kvdata and fails.
failed_players	TMap<FString, FPgosResult>	Players who totally failed, key: player_id, value: failed reason.

FPgosBatchPlayerKVDataGroupWithVerAndFails

Batch players' respective kvdata items, including players who completely failed to retrieve and keys that failed to retrieve for players who partially succeeded.

struct FPgosBatchPlayerKVDataGroupWithVerAndFails

field	type	description
data	TMap<FString, FPgosKVDataGroupWithVerAndFails>	KVData and fails of the players, key: player_id, value: the player's kvdata and fails.
failed_players	TMap<FString, FPgosResult>	Players who totally failed, key: player_id, value: failed reason.

FPgosBatchPlayerOperationResult

Batch operation results for multiple players. (Only includes failed players and their failure reasons)

struct FPgosBatchPlayerOperationResult

field	type	description
failed_players	TMap<FString, FPgosResult>	Players who totally failed, key: player_id, value: failed reason.

FPgosKVPair

K-V pair

struct FPgosKVPair

field	type	description
key	FString	key of the K-V pair
value	FString	value of the K-V pair

FPgosTitleRegionConfigKVDataQueryResult

The result of querying the specified key-value data of the title region config data.

struct FPgosTitleRegionConfigKVDataQueryResult

field	type	description
data	TMap<FString, FPgosKVDataValue>	The queried title region config kvdata items.
fails	TMap<FString, FString>	The reason why the query operation failed for these keys, key: item key, value: failed reason.

FPgosTitleConfigKVDataQueryResult

The result of querying the specified key-value data of the title config data.

struct FPgosTitleConfigKVDataQueryResult

field	type	description
data	TMap<FString, FPgosKVDataValue>	The queried title config kvdata items.
fails	TMap<FString, FString>	The reason why the query operation failed for these keys, key: item key, value: failed reason.

FPgosPlayerInfo

Base info of a player

struct FPgosPlayerInfo

field	type	description
player_id	FString	unique id of player.
display_name	FString	player's display name
gender	FString	player's gender
avatar_uri	FString	player's avatar uri
account_provider	int32	Account provider: 0 means FAS, 1 means INTL, 2 means MSDK, 3 means WeGame, 4 means PlayFab, 5 means Steam, 6 means Epic, 7 means XboxLive, 8 means PlayStationNetwork, 9 means Nintendo, 10 means JWT. Using int32 instead of enum type is to make SDK better compatible with the new account provider. More info for account provider: https://pgos.intlgame.com/pgosdoc/manual/service_manual/player_management/player_auth.html#311-login-param
account_open_id	FString	account openID
account_platform	FString	account platform name, such as: 'Steam', 'EpicGames', 'PlayStationNetwork', etc. PGOS will get and save it from the parameters passed in when the game calls 'LoginPGOS'.
account_id	FString	account platform user id owned by the player (e.g. Steam SteamID, XboxLive Xuid).
os	EPgosClientOS	The operating system the game client runs on.
custom_info	TMap<FString, FPgosKVDataValue>	custom info from player data, key: item key, value: item value.

FPgosPlayerDetail

Detailed info of a player.

struct FPgosPlayerDetail : public FPgosPlayerInfo

parent: FPgosPlayerInfo

field	type	description
language	FString	player's display language, if you want your game to be multilingual.
first_login_time	int64	player's first login Unix timestamp in the title region, in seconds.
last_login_time	int64	player's last login Unix timestamp in the title region, in seconds.
last_logout_time	int64	player's last logout Unix timestamp in the title region, in seconds.
total_time	int64	player's total online time, in seconds.
last_login_ip	FString	player's last login ip address in the title region.
cur_login_ip	FString	player's current login ip address in the title region.

FPgosChatChannelInfo

Chat channel info

struct FPgosChatChannelInfo

field	type	description
chat_channel_id	FString	An unique chat channel ID for the lobby's chat channel; empty if enable_chatting was set to false when the lobby was created.
chat_channel_name	FString	The name of chat channel to create
created_time	int64	The Unix timestamp(in seconds) when the chat channel was created.

FPgosVirtualServerReq

The request parameter of a virtual server call.

struct FPgosVirtualServerReq

field	type	description
server_name	FString	The name of the virtual server.
url	FString	[Optional] The requested url if there is any. For example: "v1/battle_settlement".
extra_headers	TMap<FString, FString>	Extra header fields required by the game. It is advisable to add a "Content-Type" field to avoid being rejected by the server, based on the request body format. for example: extra_headers["Content-Type"] = "text/plain" Here are the fields reserved for PGOS that cannot be used by the game: "SDKVersion", "ProtoVersion", "TitleId", "TitleRegionId", "SessionId", "PlayerId", "PlayerTicket", "RoutingKey", "UicAccountInfo", "SecretID", "Pid", "ServerTicket", "DstAddr", "DstCode", "AccTicket".
body	TArray<uint8>	[Optional] The request binary data.

FPgosVirtualServerResp

The response after calling a virtual server request.

struct FPgosVirtualServerResp

field	type	description
status	int32	The HTTP status code of the response.
resp_headers	TMap<FString, FString>	The HTTP header of the response.
resp_body	TArray<uint8>	The HTTP body of the response.

FPgosCurrency

In-game currency which defined on the portal.

struct FPgosCurrency

field	type	description
currency_code	FString	The code of the currency.
currency_name	FString	The name of the currency.
currency_icon	FString	The uri of the currency.
currency_type	EPgosCurrencyType	Currency type.
amount	int32	The amount of the currency.

FPgosItemContent

struct FPgosItemContent

field	type	description
item_id	FString	The id of in-game item. Use item_id to find the 'InGameItem' define through the 'ItemDict::FindItem'.
amount	int32	The amount of item in content.

FPgosInGameItem

In-game item which defined on the portal.

struct FPgosInGameItem

field	type	description
item_id	FString	The id of the item.
display_name	FString	The name of the item.
icon	FString	The uri of the item.
description	FString	The description of the item.
default_custom_data	TMap<FString, FString>	The kv data of the item. Fill in the attributes of item on the portal, such as the attack value attached to the weapon : {"attack":200}.
tags	TMap<FString, FString>	The tags of item Fill in the tags of item on the portal, such as the category of item: {"Category":"Equipment"}
item_type	EPgosInGameItemType	Item type: Dummy / Normal / Bundle / Container.
valid_duration	int32	The available duration(in seconds) after the item is instantiated to the player inventory, 0 means valid forever.
is_consumable	bool	Whether the instance of the item can be consumed by ConsumeInstance.
is_stackable	bool	Whether the instance of the item can be stacked in the player inventory.
stack_limit	int32	The limitation of stack count for stackable item instance. 0 means no limit.
is_unique	bool	Whether a player can only own one instance of the item.
item_content	TArray<FPgosItemContent>	The in-game items that this item contains
currency_content	TArray<FPgosCurrency>	The currencies that this item contains

FPgosItemInstance

struct FPgosItemInstance

field	type	description
instance_id	FString	The id of the item instance
amount	int32	The amount of the item instance
status	EPgosItemInstanceStatus	Item instance status: Dummy / Available / Expired
item	FPgosInGameItem	The base definition data of this instance which is shared by all instances generated from the same item id. Please access and edit this data in the In-Game Items page of the PGOS Portal.
mutable_custom_data	TMap<FString, FPgosKVDataValue>	The mutable kv data of the instance. Only the server can fill and modify data. The key must be prefixed with "int", "flt", or "str_", which respectively indicate that the value type is integer, float, or string. Max 32 keys, each key limited to 128 bytes and each value limited to 4096 bytes(in a narrow-character string).
mutable_custom_data_version	int32	The version of the mutable_custom_data.
tags	TMap<FString, FString>	The custom tags of the instance. Max 32 keys, each key limited to 128 bytes and each value limited to 1024 bytes(in a narrow-character string).
created_time	int64	The Unix timestamp(in seconds) when the item was instantiated to the player inventory
updated_time	int64	The Unix timestamp(in seconds) when the item instance info has be updated
expired_time	int64	The Unix timestamp(in seconds) when the item instance will be expired, 0 means valid forever.
time_to_live	int32	Up to now, the remaining time (in seconds) of the validity period of an item. For an item that valid forever, its value is 0. This is not an accurate reference value, for cases that need to be accurate, please refer to 'expired_time'.
pay_platform	FString	Pay platform name, such as: 'Steam', 'Xbox', etc. You can use macros starting with 'PAY_PLATFORM' in pgos_common_define.h
pay_platform_data	FPgosPayPlatformData	Payment platform meta data.

FPgosFailsList

A list of failed items in K-V pair data operations

struct FPgosFailsList

field	type	description
fails	TMap<FString, FString>	A list of failed items in K-V pair data operations

FPgosItemDict

struct FPgosItemDict

field	type	description
dict	TMap<FString, FPgosInGameItem>	A mapping of in-game item defines, the key is 'item id', and you can use 'ItemDict::FindItem' to search.

FPgosItemInstPack

struct FPgosItemInstPack

field	type	description
insts	TArray<FPgosItemInstance>	Item instances in the pack.
item_dict	FPgosItemDict	In-game item defines that may be referenced in the 'item_content' of a item instance. 'ItemDict::FindItem' could be used to search for particular item.

FPgosConflictUniqueItem

struct FPgosConflictUniqueItem

field	type	description
item	FPgosInGameItem	Economy item.
amount	int32	The amount of item.

FPgosRegionLatencyInfo

The latency(ms) of the region

struct FPgosRegionLatencyInfo

field	type	description
provider	FString	cloud provider, such as: aws, tcloud
region	FString	idc of the fleet
data_center	FString	The data center name and its possible values can be viewed in the 'DataCenterName' definition.
latency	int32	The latency(ms) of the region

FPgosPlayerBlobDataInfo

Player blob data information

struct FPgosPlayerBlobDataInfo

field	type	description
url	FString	A downloadable blob url, valid for one hour after the information is obtained. To download it, you can use the download function provided by the PGOS Utility module or use the download function implemented by yourself.
version	int32	The blob version number, an auto-incrementing number.
last_modified_ts	int64	The Unix timestamp(in seconds) when the blob was updated.
blob_size	int64	Size of the blob (in bytes).
blob_md5	FString	MD5 of the blob.

FPgosUpdatePBDProgressInfo

Update player blob data progress information. It will be used as the parameter type in the callback after calling the UpdatePBDFrom* API.

struct FPgosUpdatePBDProgressInfo

field	type	description
player_id	FString	The player to update blob data.
blob_key	FString	The blob key to update.
new_blob_size	int64	The new total size of the blob after the update, in bytes.
transfered_size	int64	The size of the data that has been transferred, in bytes.

FPgosHttpDownloadProgressInfo

Http download progress information. It will be used as the parameter type in the callback after calling the HttpDownload* API.

struct FPgosHttpDownloadProgressInfo

field	type	description
transfered_size	int64	The size of the data that has been transferred, in bytes.

FPgosBuffer

A regular memory buffer definition.

struct FPgosBuffer

field	type	description
buffer_ptr	const char*	The buffer address pointer, the buffer can be read, but cannot be modified and freed.
buffer_len	int64	The length of the buffer, in bytes.

FPgosBattleProperty

K-V pair property of a battle session

struct FPgosBattleProperty

field	type	description
key	FString	key of the K-V pair property of a battle session
value	FString	value of the K-V pair property of a battle session

FPgosBaseBackendEventParams

A game-defined custom value pass to PGOS backend event.

struct FPgosBaseBackendEventParams

field	type	description
event_custom_data	FString	[Optional] A game-defined custom value pass to PGOS backend event. If you need to get a custom value in the event, pass it in, otherwise, ignore this field. The API parameter structures inherited from this structure all support passing a custom data to the related events. The size is limited to 4096 bytes in a narrow-character string, if it is a wide-character string, it should be converted to a utf-8 narrow-character string before calculating its length. Detail for PGOS backend event: https://pgos.intlgame.com/pgosdoc/manual/service_manual/extensions/event.html. Detail for how to reference the 'event_custom_data':https://pgos.intlgame.com/pgosdoc/manual/service_manual/extensions/virtual_server.html#531-the-protocol-of-pgos_event.

FPgosStatItem

Statistics item instance value which includes: value, extra value, and tags.

struct FPgosStatItem

field	type	description
stat_name	FString	Stat name.
key	FString	Stat item key.
value	double	The meaning of the value varies in different scenarios: 1. Get stat item persistent value: it is item persistent value. 2. Get stat item cycle value: it is item cycle value. 3. Update stat item value: it is the value to be aggregated into the stat item.
secondary_value	double	Stat item secondary value. It will overwrite the old one when updated.
tags	TArray<FString>	Stat item tags. It will overwrite the old one when updated if 'ignore_tags' is false. Max 10 values, each value limited to 64 bytes(in a narrow-character string)
custom_data	FString	Used to store additional information. It will overwrite the old one when updated if 'ignore_custom_data' is false. Limited to 512 bytes(in a narrow-character string)
aggregate_type	EPgosAggregateType	The method to aggregate.

FPgosBatchGetStatPersistentInfoResult

Response for batch get stat persistent info result.

struct FPgosBatchGetStatPersistentInfoResult

field	type	description
items	TArray<FPgosStatItem>	Stat items obtained.

FPgosGetStatCycleInfoResult

Statistics item instance values in a cycle round.

struct FPgosGetStatCycleInfoResult

field	type	description
item	FPgosStatItem	Stat item obtained.
cycle_name	FString	The name of the cycle.
cycle_round_seq	int32	The sequence number of the cycle round, start from 1.
round_start_time	int64	The cycle round start time, Unix time in second.
round_end_time	int64	The cycle round end time, Unix time in second.

FPgosBatchGetStatCycleInfoResult

Response for batch obtaining stat cycle info result.

struct FPgosBatchGetStatCycleInfoResult

field	type	description
items	TArray<FPgosStatItem>	Stat items obtained.
cycle_name	FString	The name of the cycle.
cycle_round_seq	int32	The sequence number of the cycle round, start from 1.
round_start_time	int64	The cycle round start time, Unix time in second.
round_end_time	int64	The cycle round end time, Unix time in second.

FPgosGetStatPersistentInfoParams

struct FPgosGetStatPersistentInfoParams

field	type	description
stat_name	FString	Stat name.
key	FString	Stat item key.

FPgosBatchGetStatPersistentInfoParams

struct FPgosBatchGetStatPersistentInfoParams

field	type	description
stat_names	TArray<FString>	Stat names.
keys	TArray<FString>	Stat item keys.

FPgosGetStatCycleInfoParams

struct FPgosGetStatCycleInfoParams

field	type	description
stat_name	FString	The stat name.
key	FString	The stat item key.
cycle_name	FString	The stat cycle name.

FPgosBatchGetStatCycleInfoParams

struct FPgosBatchGetStatCycleInfoParams

field	type	description
stat_names	TArray<FString>	The stat names.
keys	TArray<FString>	The stat item keys.
cycle_name	FString	The stat cycle name.

FPgosBatchGetStatCycleRoundInfoParams

struct FPgosBatchGetStatCycleRoundInfoParams

field	type	description
cycle_names	TArray<FString>	The stat cycle names.

FPgosStatCycleRoundInfo

Current round info of cycle.

struct FPgosStatCycleRoundInfo

field	type	description
cycle_name	FString	The stat cycle name.
cycle_round_seq	int32	The sequence number of the cycle round, start from 1.
round_start_time	int64	The cycle round start time, Unix time in seconds.
round_end_time	int64	The cycle round end time, Unix time in seconds.

FPgosBatchGetStatCycleRoundInfoResult

Response for batch obtaining current round info result.

struct FPgosBatchGetStatCycleRoundInfoResult

field	type	description
round_info_map	TMap<FString, FPgosStatCycleRoundInfo>	Current round infos. key: cycle_name

FPgosTitleFileInfo

Title File detail infomation. Title File is a cloud file within title-wide, which can be managed on the portal console.

struct FPgosTitleFileInfo

field	type	description
file_name	FString	The name of the file.
url	FString	A downloadable blob url, its validity time is specified by the 'url_valid_time' parameter when getting it. To download it, you can use the download function provided by the PGOS Utility module or use the download function implemented by yourself.
updated_time	int64	The updated time of the file, UNIX time in seconds.
file_size	int64	The size of the file, in bytes.
file_md5	FString	The MD5 of the file.

FPgosGetTitleFileInfoParams

The parameter struct to get title file info.

struct FPgosGetTitleFileInfoParams

field	type	description
paths	TArray<FString>	The list contains the full paths of title files from which information will be retrieved, with a maximum size of 100 paths. Note: file&folder names are case-insensitive, meaning that "/config/rules.json" and "/CONFIG/RULES.JSON" are considered the same file.
url_valid_time	int32	The valid duration(in seconds) of the file download URL, after which the URL will no longer be downloadable. Its value must be greater than 0, otherwise the operation will fail.

FPgosGetTitleFileInfoResult

Response for getting title file info.

struct FPgosGetTitleFileInfoResult

field	type	description
data	TMap<FString, FPgosTitleFileInfo>	Obtained title file informations, key: file path, value: file info.
fails	TMap<FString, FString>	The reason why the query operation failed for these paths, key: file path, value: failed reason.

FPgosPlayerDesc

Player description

struct FPgosPlayerDesc

field	type	description
player_info	FPgosPlayerInfo	Base info of a player.
team	FString	The name of the player's team.
match_attributes	TMap<FString, FPgosKVDataValue>	Attributes used by the Matchmaking, map key: attribute name, map value: attribute value.

FPgosBattleTeam

The structure of a team in a battle session.

struct FPgosBattleTeam

field	type	description
name	FString	Team name
players	TArray<FPgosPlayerDesc>	A ordered array of team members. When a team slot is empty in battle session from a lobby, the player_id will be filled as empty

FPgosBattleSourceData

Creation source data of a battle session

struct FPgosBattleSourceData

field	type	description
source_type	EPgosBattleSourceType	What service that the battle session generated from
configuration_name	FString	configuration_name Matchmaking configuration name or lobby configuration name
ruleset_name	FString	Ruleset name hit. Filled when battle session source type is BattleSourceType::Matchmaking
teams	TArray<FPgosBattleTeam>	Teams of the battle session

FPgosTagDataFilter

Filter for tag data.

struct FPgosTagDataFilter

field	type	description
key	FString	Tag name.
value	FString	Tag value.
op	EPgosFilterComparisonOperator	Operation type.