Edit

Share via

PlayFabMultiplayer.PlayFabMultiplayerServer.CreateServerBackfillTicket method

Creates a server backfill ticket.

public static MatchmakingTicket CreateServerBackfillTicket(PFEntityKey server, string queueName, 
    List<MatchUser> matchMembers, MultiplayerServerDetails serverDetails, 
    uint timeoutInSeconds = 300)
parameter description
server The server entity.
queueName The queue to which the ticket belongs.
matchMembers The members currently in the match.
serverDetails The details about the PlayFab Multiplayer Server that the ticket is for. The server details are optional. If no server details need to be provided to clients on match completion, this value can be null. Similarly, any of the fields in the server details don't need to be provided to clients can be empty or null.
timeoutInSeconds How long to attempt matchmaking the ticket, in seconds. Defaults to 300 seconds.

Return Value

The resulting ticket object.

Remarks

The library automatically, and asynchronously, will submit a server backfill ticket to the matchmaking service. Each time the ticket status changes, a OnMatchmakingTicketStatusChanged will be provided. The ticket status can be queried at any time via Status. The ticket immediately starts in the MatchmakingTicketStatus.Creating state.

When the ticket has completed, a OnMatchmakingTicketStatusChanged will be provided. At that point, a match for the backfill ticket will have been found or the ticket stopped due to failure. On success, the match that was found can be queried via GetMatchDetails. The regionPreferences in regionPreferences will only contain the region that the server is located in.

This function requires that a previous call to SetEntityToken was made to set the game server entity token.

While this method is present in the unified, cross-platform header, it is only implemented for Windows and, Xbox. The method will return errors on other platforms.

See Also

  • Last updated on