Matchmaking SDK Reference #

This section provides references for Matchmaking methods, classes, and events in the Pragma SDK for Unreal and Unity. For information on Pragma Engine backend classes and plugins, see Matchmaking Backend Reference.

The Pragma SDK provides methods that developers can use to facilitate matchmaking processes, such as entering, leaving, or re-entering matchmaking. The SDK includes methods for Matchmaking service implementation through the PartyApi and the MatchApi, depending on whether the call comes from the player client or game server, respectively. The tables below contains a list of all the methods relevant to the Matchmaking service.

Party API (player client) SDK methods #

methoddescription
EnterMatchmaking()Enters the party into matchmaking once all players are ready. Only a party leader can enter a party into matchmaking.
LeaveMatchmaking()Removes a party from matchmaking
GetMatchmakingInfo()Gets matchmaking queue information

Match API (game server) SDK methods #

methoddescription
EnterMatchmaking()Enters an existing game instance into matchmaking to find more players
LeaveMatchmaking()Removes a game instance from matchmaking

The SDK calls invoke various Matchmaking Plugin methods through Matchmaking service RPCs.

Events #

There are several matchmaking-related events that player clients and game servers can listen to. The following tables contain bindable events relevant to the Matchmaking service, along with associated descriptions of when the event is triggered.

Player client events #

The following events are handled by the player client.

EventTriggerData returned
OnEnteredMatchmakingThe party enters matchmakingN/A
OnLeftMatchmakingThe party leaves matchmakingN/A
OnMatchmakingFailedPlayer is removed from matchmakingMatchmaking failure reason (UNSPECIFIED or GAME_SERVER_VERSION_NO_LONGER_COMPATIBLE)

Game server events #

The following events are handled by the game server.

EventTriggerData returned
OnGameInstanceEnteredMatchmakingThe given active game instance enters matchmakinggame instance ID
OnGameInstanceLeftMatchmakingThe given active game instance leaves matchmakinggame instance ID

Game Instance
Game Instance Overview