Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Creates a matchmaking ticket for one or more local users.
Syntax
HRESULT PFMultiplayerCreateMatchmakingTicket(
PFMultiplayerHandle handle,
uint32_t localUserCount,
const PFEntityKey* localUsers,
const char* const* localUserAttributes,
const PFMatchmakingTicketConfiguration* configuration,
void* asyncContext,
PFMatchmakingTicketHandle* ticket
)
Parameters
handle PFMultiplayerHandle
The handle of the PFMultiplayer API instance.
localUserCount uint32_t
The count of local users to include in the ticket.
localUsers const PFEntityKey*
input array of size localUserCount
The array of local users to include in the ticket.
localUserAttributes const char* const*
input array of size localUserCount
The array of local user attribute strings. There should be one attribute string for each local user. Each attribute string should either be an empty string or a serialized JSON object. For example, {"player_color":"blue","player_role":"tank"}.
configuration const PFMatchmakingTicketConfiguration*
The ticket configuration.
asyncContext void*
optional
An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.
ticket PFMatchmakingTicketHandle*
library-allocated output
The resulting ticket object.
Return value
Type: HRESULT
S_OK if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PFMultiplayerGetErrorMessage().
The function can return these errors before it starts the asynchronous operation:
| Error | Cause |
|---|---|
E_POINTER |
configuration or ticket is nullptr, or localUserCount is greater than 0 and localUsers or localUserAttributes is nullptr. |
0x89236309 |
localUserCount is 0. Specify at least one local user. |
0x89236308 |
A user appears more than once in localUsers, more than once in the membersToMatchWith field of configuration, or in both lists. |
For the list of error codes, see PlayFab Multiplayer C++ SDK error codes.
Remarks
The library automatically, and asynchronously, submits all specified local users on a ticket to the matchmaking service. Each time the ticket status changes, a PFMatchmakingTicketStatusChangedStateChange is provided. The ticket status can be queried at any time via PFMatchmakingTicketGetStatus(). The ticket immediately starts in the PFMatchmakingTicketStatus::Creating state.
When the ticket completes, the library provides a PFMatchmakingTicketStatusChangedStateChange with the final status, followed by a PFMatchmakingTicketCompletedStateChange whose result field reports success or the failure reason and whose asyncContext field contains the value you passed to this call. At that point, a match was found or the ticket stopped due to failure. If you destroy the ticket with PFMultiplayerDestroyMatchmakingTicket before it completes, the library doesn't provide the completion state change. On success, the match that was found can be queried via PFMatchmakingTicketGetMatch().
If ticket creation fails because there are already too many tickets for the specified users, the library transparently cancels those outstanding tickets and then retries ticket creation.
A match can't be found until all remote users specified in the membersToMatchWith field of the configuration parameter join the ticket via PFMultiplayerJoinMatchmakingTicketFromId().
Requirements
Header: PFMatchmaking.h