You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/content/en/docs/Contribute/_index.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ If there's something you see that can be [improved](https://github.com/googlefor
13
13
14
14
There are many ways to get in touch with the Open Match community.
15
15
16
-
*[Slack](https://open-match.slack.com/) ([Join](https://join.slack.com/t/open-match/shared_invite/enQtNDM1NjcxNTY4MTgzLWQzMzE1MGY5YmYyYWY3ZjE2MjNjZTdmYmQ1ZTQzMmNiNGViYmQyN2M4ZmVkMDY2YzZlOTUwMTYwMzI1Y2I2MjU)) - Talk to the Open Match engineers and users on Slack.
16
+
*[Slack](https://open-match.slack.com/) ([Join](https://open-match.slack.com/join/shared_invite/zt-5k57lph3-Oe0WdatzL32xv6tPG3PfzQ#/)) - Talk to the Open Match engineers and users on Slack.
17
17
*[open-match-discuss@ mailing list](https://groups.google.com/forum/#!forum/open-match-discuss) - Get the latest information on changes happening to Open Match.
| FetchMatches | [FetchMatchesRequest](#openmatch.FetchMatchesRequest) | [FetchMatchesResponse](#openmatch.FetchMatchesResponse) stream | FetchMatches triggers a MatchFunction with the specified MatchProfile and returns a set of match proposals that match the description of that MatchProfile. FetchMatches immediately returns an error if it encounters any execution failures. |
284
+
| FetchMatches | [FetchMatchesRequest](#openmatch.FetchMatchesRequest) | [FetchMatchesResponse](#openmatch.FetchMatchesResponse) stream | FetchMatches triggers a MatchFunction with the specified MatchProfile and returns a set of matches generated by the Match Making Function, and accepted by the evaluator. Tickets in matches returned by FetchMatches are moved from active to pending, and will not be returned by query. |
285
285
| AssignTickets | [AssignTicketsRequest](#openmatch.AssignTicketsRequest) | [AssignTicketsResponse](#openmatch.AssignTicketsResponse) | AssignTickets overwrites the Assignment field of the input TicketIds. |
286
-
| ReleaseTickets | [ReleaseTicketsRequest](#openmatch.ReleaseTicketsRequest) | [ReleaseTicketsResponse](#openmatch.ReleaseTicketsResponse) | ReleaseTickets removes the submitted tickets from the list that prevents tickets that are awaiting assignment from appearing in MMF queries, effectively putting them back into the matchmaking pool
286
+
| ReleaseTickets | [ReleaseTicketsRequest](#openmatch.ReleaseTicketsRequest) | [ReleaseTicketsResponse](#openmatch.ReleaseTicketsResponse) | ReleaseTickets moves tickets from the pending state, to the active state. This enables them to be returned by query, and find different matches.
287
+
288
+
BETA FEATURE WARNING: This call and the associated Request and Response messages are not finalized and still subject to possible change or removal. |
289
+
| ReleaseAllTickets | [ReleaseAllTicketsRequest](#openmatch.ReleaseAllTicketsRequest) | [ReleaseAllTicketsResponse](#openmatch.ReleaseAllTicketsResponse) | ReleaseAllTickets moves all tickets from the pending state, to the active state. This enables them to be returned by query, and find different matches.
287
290
288
291
BETA FEATURE WARNING: This call and the associated Request and Response messages are not finalized and still subject to possible change or removal. |
289
292
@@ -475,7 +478,7 @@ The FrontendService implements APIs to manage and query status of a Tickets.
475
478
| Method Name | Request Type | Response Type | Description |
| CreateTicket | [CreateTicketRequest](#openmatch.CreateTicketRequest) | [Ticket](#openmatch.Ticket) | CreateTicket assigns an unique TicketId to the input Ticket and record it in state storage. A ticket is considered as ready for matchmaking once it is created. - If a TicketId exists in a Ticket request, an auto-generated TicketId will override this field. - If SearchFields exist in a Ticket, CreateTicket will also index these fields such that one can query the ticket with query.QueryTickets function. |
478
-
| DeleteTicket | [DeleteTicketRequest](#openmatch.DeleteTicketRequest) | [.google.protobuf.Empty](#google.protobuf.Empty) | DeleteTicket immediately stops Open Match from using the Ticket for matchmaking and removes the Ticket from state storage. The client must delete the Ticket when finished matchmaking with it. - If SearchFields exist in a Ticket, DeleteTicket will deindex the fields lazily. Users may still be able to assign/get a ticket after calling DeleteTicket on it. |
481
+
| DeleteTicket | [DeleteTicketRequest](#openmatch.DeleteTicketRequest) | [.google.protobuf.Empty](#google.protobuf.Empty) | DeleteTicket immediately stops Open Match from using the Ticket for matchmaking and removes the Ticket from state storage. The client should delete the Ticket when finished matchmaking with it. |
479
482
| GetTicket | [GetTicketRequest](#openmatch.GetTicketRequest) | [Ticket](#openmatch.Ticket) | GetTicket get the Ticket associated with the specified TicketId. |
480
483
| WatchAssignments | [WatchAssignmentsRequest](#openmatch.WatchAssignmentsRequest) | [WatchAssignmentsResponse](#openmatch.WatchAssignmentsResponse) stream | WatchAssignments stream back Assignment of the specified TicketId if it is updated. - If the Assignment is not updated, GetAssignment will retry using the configured backoff strategy. |
481
484
@@ -549,8 +552,8 @@ The MatchFunction service implements APIs to run user-defined matchmaking logics
549
552
<a name="openmatch.Assignment"></a>
550
553
551
554
### Assignment
552
-
An Assignment represents a game server assignment associated with a Ticket. Open
553
-
match does not require or inspect any fields on assignment.
555
+
An Assignment represents a game server assignment associated with a Ticket.
556
+
Open Match does not require or inspect any fields on assignment.
554
557
555
558
556
559
| Field | Type | Label | Description |
@@ -804,20 +807,21 @@ does not match:
804
807
<a name="openmatch.Ticket"></a>
805
808
806
809
### Ticket
807
-
A Ticket is a basic matchmaking entity in Open Match. A Ticket represents either an
808
-
individual 'Player' or a 'Group' of players. Open Match will not interpret
809
-
what the Ticket represents but just treat it as a matchmaking unit with a set
810
-
of SearchFields. Open Match stores the Ticket in state storage and enables an
811
-
Assignment to be associated with this Ticket.
810
+
A Ticket is a basic matchmaking entity in Open Match. A Ticket may represent
811
+
an individual 'Player', a 'Group' of players, or any other concepts unique to
812
+
your use case. Open Match will not interpret what the Ticket represents but
813
+
just treat it as a matchmaking unit with a set of SearchFields. Open Match
814
+
stores the Ticket in state storage and enables an Assignment to be set on the
815
+
Ticket.
812
816
813
817
814
818
| Field | Type | Label | Description |
815
819
| ----- | ---- | ----- | ----------- |
816
820
| id | [string](#string) | | Id represents an auto-generated Id issued by Open Match. |
817
-
| assignment | [Assignment](#openmatch.Assignment) | | An Assignment represents a game server assignment associated with a Ticket. Open Match does not require or inspect any fields on Assignment. |
821
+
| assignment | [Assignment](#openmatch.Assignment) | | An Assignment represents a game server assignment associated with a Ticket, or whatever finalized matched state means for your use case. Open Match does not require or inspect any fields on Assignment. |
818
822
| search_fields | [SearchFields](#openmatch.SearchFields) | | Search fields are the fields which Open Match is aware of, and can be used when specifying filters. |
819
823
| extensions | [Ticket.ExtensionsEntry](#openmatch.Ticket.ExtensionsEntry) | repeated | Customized information not inspected by Open Match, to be used by the match making function, evaluator, and components making calls to Open Match. Optional, depending on the requirements of the connected systems. |
820
-
| create_time | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Create time represents the time at which this Ticket was created. It is populated by Open Match at the time of Ticket creation. |
824
+
| create_time | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Create time is the time the Ticket was created. It is populated by Open Match at the time of Ticket creation. |
821
825
822
826
823
827
@@ -929,8 +933,8 @@ The QueryService service implements helper APIs for Match Function to query Tick
929
933
930
934
| Method Name | Request Type | Response Type | Description |
| QueryTickets | [QueryTicketsRequest](#openmatch.QueryTicketsRequest) | [QueryTicketsResponse](#openmatch.QueryTicketsResponse) stream | QueryTickets gets a list of Tickets that match all Filters of the input Pool. - If the Pool contains no Filters, QueryTickets will return all Tickets in the state storage. QueryTickets pages the Tickets by `storage.pool.size` and stream back responses. - storage.pool.size is default to 1000 if not set, and has a mininum of 10 and maximum of 10000. |
933
-
| QueryTicketIds | [QueryTicketIdsRequest](#openmatch.QueryTicketIdsRequest) | [QueryTicketIdsResponse](#openmatch.QueryTicketIdsResponse) stream | QueryTicketIds gets the list of TicketIDs that meet all the filtering criteria requested by the pool. - If the Pool contains no Filters, QueryTicketIds will return all TicketIDs in the state storage. QueryTicketIds pages the TicketIDs by `storage.pool.size` and stream back responses. - storage.pool.size is default to 1000 if not set, and has a mininum of 10 and maximum of 10000. |
936
+
| QueryTickets | [QueryTicketsRequest](#openmatch.QueryTicketsRequest) | [QueryTicketsResponse](#openmatch.QueryTicketsResponse) stream | QueryTickets gets a list of Tickets that match all Filters of the input Pool. - If the Pool contains no Filters, QueryTickets will return all Tickets in the state storage. QueryTickets pages the Tickets by `queryPageSize` and stream back responses. - queryPageSize is default to 1000 if not set, and has a mininum of 10 and maximum of 10000. |
937
+
| QueryTicketIds | [QueryTicketIdsRequest](#openmatch.QueryTicketIdsRequest) | [QueryTicketIdsResponse](#openmatch.QueryTicketIdsResponse) stream | QueryTicketIds gets the list of TicketIDs that meet all the filtering criteria requested by the pool. - If the Pool contains no Filters, QueryTicketIds will return all TicketIDs in the state storage. QueryTicketIds pages the TicketIDs by `queryPageSize` and stream back responses. - queryPageSize is default to 1000 if not set, and has a mininum of 10 and maximum of 10000. |
0 commit comments