Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NetworkMatch.ListMatches

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function ListMatches(startPageNumber: int, resultPageSize: int, matchNameFilter: string, callback: ResponseDelegate<ListMatchResponse>): Coroutine;
public Coroutine ListMatches(int startPageNumber, int resultPageSize, string matchNameFilter, ResponseDelegate<ListMatchResponse> callback);
public function ListMatches(req: Networking.Match.ListMatchRequest, callback: ResponseDelegate<ListMatchResponse>): Coroutine;
public Coroutine ListMatches(Networking.Match.ListMatchRequest req, ResponseDelegate<ListMatchResponse> callback);

Parameters

callback A callback delegate that takes a JoinMatchResponse that indicates the return of the request after coroutine processing.
req A ListMatchRequest describing the match to destroy.
startPageNumber First page of results.
resultPageSize Number of matches in each page.
matchNameFilter String to filter names on.

Returns

Coroutine A coroutine for managing the async operation. if using the callback, this can be ignored.

Description

This requests a list of the active matches from a UNET MatchMaker.

This is asynchronous, the callback function will be invoked when the operation completes.