Skip to main content
Version: 5.7.0

FindPlayersUsingScript

Finds matchmaking enabled players using optionally specified filter script and optional player rating override. Passing empty string (i.e. "") for scriptName will not run a script filter. Passing null will invoke the configured script similar to findPlayersUsingFilter.

Similarly passing null for player rating will use the players current rating.

Additional information of filters can be found under Matchmaking Filters.

ServiceOperation
matchMakingFIND_PLAYERS_USING_SCRIPT

Method Parameters

ParameterDescription
rangeDeltaHow close an opponents rating must be to yours
numMatchesThe maximum number of matches to return
playerRatingPlayer rating override
scriptNameName of filter script
jsonExtraParmsParameters to be passed to the filter

Usage

http://localhost:3000
// Cloud Code only. To view example, switch to the Cloud Code tab
JSON Response
{
"status": 200,
"data": {
"matchesFound": [
{
"pictureUrl": null,
"playerName": "UserC-1239941736",
"playerId": "c2b88d3f-2s32-43a6-9a71-0f0157e46505",
"playerRating": 0,
"summaryFriendData": null
},
{
"pictureUrl": null,
"playerName": "UserA-914307852",
"playerId": "96afefc7-02b2-4148-8d36-c62855d917b6",
"playerRating": 0,
"summaryFriendData": null
}
]
}
}