Skip to main content

Server Party API Reference

Party is a service for creating an instant team for players. The player can use it to build a "temporary virtual team" and then fire a battle.

API List

APIDescription
BatchGetPlayerCurrentPartyIdsBGet the current party ids of players, if a player is not in any party currently, the corresponding party id is empty string
GetPartyInfoGet party info by party id

API Details

BatchGetPlayerCurrentPartyIds

BGet the current party ids of players, if a player is not in any party currently, the corresponding party id is empty string

/**
* BGet the current party ids of players, if a player is not in any party currently, the corresponding party id is empty string
*
* @param ResultCallback The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.
*/
void BatchGetPlayerCurrentPartyIds(
const FPgosServerBatchGetPlayerCurrentPartyIdsParams& Params,
TFunction<void(const FPgosResult& Ret, const FPgosServerBatchGetPlayerCurrentPartyIdsResult* Data)> ResultCallback) const;

Parameters:

ParamTypeDescription
Paramsconst FPgosServerBatchGetPlayerCurrentPartyIdsParams&
ResultCallbackTFunction<void(const FPgosResult& Ret, const FPgosServerBatchGetPlayerCurrentPartyIdsResult* Data)>The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.

Return: void

GetPartyInfo

Get party info by party id

/**
* Get party info by party id
*
* @param ResultCallback The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.
*/
void GetPartyInfo(
const FPgosServerGetPartyInfoParams& Params,
TFunction<void(const FPgosResult& Ret, const FPgosServerGetPartyInfoResult* Data)> ResultCallback) const;

Parameters:

ParamTypeDescription
Paramsconst FPgosServerGetPartyInfoParams&
ResultCallbackTFunction<void(const FPgosResult& Ret, const FPgosServerGetPartyInfoResult* Data)>The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.

Return: void