Party Reference #

Party service SDK #

Developers can use the Pragma Party API to implement Party service capabilities, such as assigning a party leader and leaving a party.

The table below contains a list of the SDK methods relevant to the Party service. These methods are available via the Party API for Unreal or the Game Loop API for Unity.

Call	description
`Initialize` (Unreal only)	Initialize the client’s party API state and synchronizes party state with the platform. Must be called prior to using other functionality on the API.
`ForceSync` (Unreal only)	Forcibly synchronize the player client party cache with the party information in the Pragma Engine backend
`CreateParty`	Create a new party
`SendPartyInvite`	Send a party invite to a specific player
`RespondToPartyInvite`	Accept or reject another player’s invite to a party
`JoinPartyWithInviteCode`	Join a party using an invite code
`JoinPartyWithId`	Join a party using a party ID
`LeaveParty`	Leave a party voluntarily
`AssignPartyLeader`	Assign a party leader
`KickPlayerFromParty`	Forcibly remove a player from a party
`UpdatePartyPlayer`	Update custom party player information when in a party
`UpdateParty`	Update custom party information
`SetPartyPlayerReady`	Set the player’s `Ready` value
`SetPartyPreferredGameServerZones`	Update the `GameServerZones` value for the party
`SetPartyPlayerGameServerZoneToPing`	Update the `GameServerZoneToPing` value for the party
`EnterMatchmaking`	Enter the party into matchmaking once all players are ready. Only a party leader can enter a party into matchmaking.
`LeaveMatchmaking`	Remove a party from matchmaking
`GetMatchmakingInfo`	Get matchmaking queue information

The Party Tasks explains how to use these calls to invoke Party Plugin methods and customize party functionality.

The Party Plugin #

The Party Plugin provides a location for developers to implement custom party functionality. The Party Service Tasks topic explains how to use the Party Plugin methods, along with the SDKs that invoke them.

Data classes #

There are two main data classes within the Party service: Party and PartyPlayer. These classes are created by the platform and handed to plugins to customize at the extension points described later on this page.

The Party class #

property	description
`id`	Unique identifier for the party
`players`	List of PartyPlayer objects in the party
`inviteCode`	Auto-generated unique string for the party that players can use to join
`maxPlayerCount`	Number representing the maximum amount of players for the party set via the `PartyService` config
`gameServerVersion`	Game server version that maps to the `PartyPlayer`s `gameClientVersion`, according to the values in the PartyConfig. This value is updated whenever a player joins or leaves the party, or attempts to join matchmaking.
`overrideGameServerVersion`	Boolean indicating whether to use the game server/client mapping specified in the PartyConfig.
`preferredGameServerZones`	List of game server zones that the party can play a match on
`ext`	Custom `ExtParty` payload containing party data for the platform to use

The PartyPlayer class #

property	description
`playerId`	A user’s identifier within a specific game
`socialId`	Unique social identifier for the player
`displayName`	`PragmaDisplayName` object containing the player’s name and discriminator
`inventory`	Snapshot of the player’s inventory from when they entered the party or last completed a match
`gameClientVersion`	Version of the game client the player is currently running
`isReady`	Boolean indicating if this player ready to play a match
`isLeader`	Boolean indicating if this player is a leader in this party
`gameServerZoneToPing`	Map of this player’s ping to various game server zones
`ext`	Custom `ExtPartyPlayer` payload containing player data for the platform to use

Configuration #

The PartyConfig configuration class provides a place to define default values for the Party service. The following configuration values are available:

config	description
`maxPlayersPerParty`	Maximum players allowed in each party
`disableMaxPlayerCount`	Whether to disable maximum player count limits in each party
`enableLocalGameServerVersions`	Whether to allow local game clients to override their game server version for local development purposes
`repeatInviteDelaySeconds`	Defines the delay (in number of seconds) between a player sending a party invite to another player consecutive times
`inventoryTagsToInclude`	Tags used to filter player inventories. Items that match one or more tags will be included
`enableTransferPartyLeader`	Whether to transfer party leader status from one player to another when invoking `AssignPartyLeader`
`enableGameServerVersionDefault`	If enabled, use the `gameServerVersionDefault` server version for clients not defined in the `gameServerVersionCompatibility` map
`gameServerVersionDefault`	Default game server version for clients not defined in the `gameServerVersionCompatibility` map. This value is used if `enableGameServerVersionDefault` is true. See Manage game server compatibility for more details.
`gameServerVersionCompatibility`	Map of all the server versions to compatible game client versions
`enableStalePartyExpiration`	Whether to enable the party expiration feature
`stalePartyExpirationMinutes`	Time, in minutes, to wait before terminating a party. 0 or negative values means parties will never timeout. Will be ignored if `enableStalePartyExpiration` is false.

Extension data #

You can use Extension Data (exts) to define custom data about players and parties as the party travels through the game loop. These fields are stored on the Party or PartyPlayer classes, and are passed to other plugins as necessary. See Party Service Tasks for sample implementation.

The following table lists the ext payloads relevant to party and player information.

`ext`	description	example data
`ExtCreateRequest`	Party data passed from the player client to the Party Plugin’s `initialize` method during party creation.	map or game mode
`ExtPlayerJoinRequest`	Data related to the player joining the party. This `ext` is passed from the player client to the Party Plugin when the player is added to a party.	selected character
`ExtParty`	Additional party data for the platform to use. This `ext` is populated when a party is created, and is stored in the engine for the life of the party. This data is for platform use and is hidden by default.	matchmaking style, game instance duration
`ExtPartyPlayer`	Additional data about a single player in a party. This `ext` is populated when a player joins a party, and is stored in the engine for as long as the player is in the party. This data is for platform use and is hidden by default.	costume catalog id
`ExtBroadcastParty`	Party data that is populated by the Party Plugin’s `buildExtBroadcastParty` method and passed to all player clients on the `OnPartyChanged` event when their party is updated (including party creation and destruction).	game mode, game instance duration
`ExtBroadcastPlayer`	Player data that is populated by the Party Plugin’s `buildExtBroadcastPlayer` method and passed to all player clients when their party is updated (including party creation and destruction). Players receive a separate `ExtBroadcastPlayer` payload on the `OnPartyChanged` event for each player in the party.	selected character
`ExtPrivatePlayer`	Private player data that is populated by the Party Plugin’s `buildExtPrivatePlayer` method and passed to a player client when their party is updated (including party creation and destruction). Each player receives only their own `ExtPrivatePlayer` payload on the `OnPartyChanged` event.	VoIP token
`ExtUpdatePartyRequest`	Party data passed from a player client to the Party Plugin’s `updateParty` method. Information sent on this payload updates the data stored in the `ExtParty` proto.	updated game mode
`ExtUpdatePartyPlayerRequest`	Player data passed from a player client to the Party Plugin’s `updatePlayer` method. Information sent on this payload updates the data stored in the `ExtPartyPlayer` proto.	updated inventory version, costume, character

Events #

There are several party-related events that player clients can listen to. The following table contains bindable events relevant to the Party service, along with associated descriptions of when the event is triggered.

The following events are defined in the Party API for Unreal and the Game Loop API for Unity.

Event	Trigger	Data returned
`OnJoinedParty`	A player joins a party	Party
`OnPartyUpdated` (Unreal) `OnPartyChanged`(Unity)	Party information changes, including creation and destruction Note: All other applicable `On*` events fire in addition to this one, so developers will need to account for handling multiple events at once.	N/A
`OnPartyInviteCodeChanged`	A new invite code is made for the party	invite code
`OnExtBroadcastPartyChanged`	The public `ext` party selections change	`ExtBroadcastParty`
`OnPartyPreferredGameServerZonesChanged`	A party’s preferred game server zones change	Array of preferred game server zones
`OnLeftParty`	Your player leaves the party voluntarily	N/A
`OnRemovedFromParty`	Your player leaves a party for reasons outside of your control	Removal reason (`REMOVAL_REASON_UNSPECIFIED`, `KICKED`, `LEFT`, `DISCONNECTED`, or `EXPIRED`)
`OnPartyPlayersChanged`	One or more players join or leave the party	PartyPlayer for each player that joins or leaves
`OnPlayerJoinedParty`	A new player joins the party. All players in the party can handle this event	PartyPlayer for the player that joined the party
`OnPartyPlayerDataChanged`	Any player information changes	PartyPlayer for the player whose data changed
`OnPlayerLeftParty`	A player leaves the party	PartyPlayer for the player that left the party
`OnExtPrivatePlayerChanged`	A player’s private selections changes	`ExtPrivatePlayer`
`OnPartyInvitesChanged`	An invite is created or responded to	invite ID, inviter’s player ID
`OnPartyInviteReceived`	A party invite is received from another player	invite ID, inviter’s player ID
`OnPartyInviteRevoked`	A party invite is revoked, such as when pending invites are canceled by a game starting a match	invite ID
`OnPartyInviteAccepted`	An invitee accepts the invite. Only inviters can handle this event	invite ID
`OnPartyInviteDeclined`	An invitee declines the invite. Only inviters can handle this event	invite ID
`OnGameClientVersionUpdateRequired`	The player client needs to update their `GameClientVersion`	N/A
`OnPartyClientVersionMismatch`	Cannot find a game server version that is compatible with every player in the party	N/A
`OnEnteredMatchmaking`	Party enters matchmaking	N/A
`OnLeftMatchmaking`	Party leaves matchmaking	N/A
`OnMatchmakingFailed`	There is a failure in matchmaking	Failure reason (`UNSPECIFIED` or `GAME_SERVER_VERSION_NO_LONGER_COMPATIBLE`)

Errors #

The following errors are relevant to the Party service.

PartyService_PartyNotFound
PartyService_AlreadyInParty
PartyService_InvalidState
PartyService_NotInParty
PartyService_PlayerNotLeader
PartyService_PlayersNotReady
PartyService_FailedToEnterMatchmaking
PartyService_InviteNotFound
PartyService_PartyFull
PartyService_InvalidSession
PartyService_PartyClientVersionMismatch
PartyService_OverrideGameServerVersionDisabled
PartyService_GameServerNoLongerCompatible
PartyService_LeavePartyFailed
PartyService_PlayerNotFound
PartyService_PlayerIsKicked
PartyService_CanNotKickSelf
PartyService_PlayersAlreadyInGameLoop
PartyService_PlayerIsLeader
PartyService_FailedToLeaveMatchmaking