MatchmakingTicket
import type { MatchmakingTicket } from "https://aws-api.deno.dev/v0.4/services/gamelift.ts?docs=full";
Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request.
§Properties
Name of the matchmaking configuration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation.
Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
Connection information for a new game session. Once a match is made, the FlexMatch engine creates a new game session for it. This information is added to the matchmaking ticket, which you can be retrieve by calling DescribeMatchmaking .
A set of Player
objects, each representing a player to find matches for.
Players are identified by a unique player ID and may include latency data for use during matchmaking.
If the ticket is in status COMPLETED
, the Player
objects include the team the players were assigned to in the resulting match.
Time stamp indicating when this matchmaking request was received.
Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
Current status of the matchmaking request.
- QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
- SEARCHING -- The matchmaking request is currently being processed.
- REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match. This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
- PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
- COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
- FAILED -- The matchmaking request was not completed.
- CANCELLED -- The matchmaking request was canceled.
This may be the result of a
StopMatchmaking
operation or a proposed match that one or more players failed to accept. - TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.
Note: Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.