SparkMatchConfig

Contains configuration information for the match

getShortCode

signature getShortCode()

returns string

validity All Scripts

Returns the shortCode of the match

getName

signature getName()

returns string

validity All Scripts

Returns the name of the match

getDescription

signature getDescription()

returns string

validity All Scripts

Returns the description of the match

getMinPlayers

signature getMinPlayers()

returns number

validity All Scripts

Returns the minimum number of players in the match

getMaxPlayers

signature getMaxPlayers()

returns number

validity All Scripts

Returns the minimum number of players in the match

getRealtime

signature getRealtime()

returns boolean

validity All Scripts

Returns the minimum number of players in the match

getRealtimeScript

signature getRealtimeScript()

returns string

validity All Scripts

Returns the Realtime script

getDropInDropOut

signature getDropInDropOut()

returns boolean

validity All Scripts

Returns true if the match is Drop In/Drop Out

getDropInDropOutExpire

signature getDropInDropOutExpire()

returns number

validity All Scripts

Returns the number of seconds before Drop In/Drop Out expires

getManuallyMatch

signature getManuallyMatch()

returns boolean

validity All Scripts

Returns true if the match is a manual match

getPlayerDisconnectThreshold

signature getPlayerDisconnectThreshold()

returns number

validity All Scripts

Returns the number of seconds before players are disconnected for Drop In/Drop Out matches

getThresholds

signature getThresholds()

returns List

validity All Scripts

Returns a list of thresholds in the match

createPendingMatch

signature createPendingMatch(string matchGroup, number skill, SparkPlayer[] players)

returns PendingMatch

validity All Scripts

Creates a new pending match containing the given players.

Any existing pending matches for these players with the same matchGroup will be cancelled.

createPendingMatchWithCustomQuery

signature createPendingMatchWithCustomQuery(string matchGroup, number skill, JSON customQuery, JSON matchData, SparkPlayer[] players)

returns PendingMatch

validity All Scripts

Creates a new pending match containing the given players.

Any existing pending matches for these players with the same matchGroup will be cancelled.

Did this page help you? Please enter your feedback below. For questions about using this part of the platform, please contact support here