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

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

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.