PendingMatch
An object that represents a pending match.
getId
signature getId()
returns string
validity All Scripts
The ID for the pending match.
example
pendingMatch.getId();
getMatchShortCode
signature getMatchShortCode()
returns string
validity All Scripts
The match shortCode for the pending match.
example
pendingMatch.getMatchShortCode();
getMatchGroup
signature getMatchGroup()
returns string
validity All Scripts
The match group for the pending match.
example
pendingMatch.getMatchGroup();
getSkill
signature getSkill()
returns number
validity All Scripts
The average skill of players in this pending match.
example
pendingMatch.getSkill();
getMatchedPlayers
signature getMatchedPlayers()
returns SparkMatchedPlayer[]
validity All Scripts
The players already part of this pending match.
example
pendingMatch.getMatchedPlayers();
joinPendingMatch
signature joinPendingMatch(PendingMatch pendingMatchToJoin)
returns PendingMatch
validity All Scripts
Join this pending match to the given pending match.
returns
The merged SparkPendingMatch if it was joined successfully,
or null if the pendingMatch could not be joined.
example
pendingMatch.joinPendingMatch(otherPendingMatch);
findPendingMatches
signature findPendingMatches(number maxMatchesToFind)
returns SparkPendingMatch[]
validity All Scripts
Find pending matches that are suitable for matchmaking with this one.
parameters
maxMatchesToFind - the maximum number of results to return
returns
An array of pending matches suitable for matching with this one.
example
pendingMatch.findPendingMatches();
getMatchData
signature getMatchData()
returns JSON
validity All Scripts
Returns the matchData for the pending match.
example
pendingMatch.getMatchData();