SparkConfig

Contains configuration information for the game

getStage

signature getStage()

returns string

validity All Scripts

Returns the stage (preview or live) the game is running on

getApiKey

signature getApiKey()

returns string

validity All Scripts

Returns the apiKey of the game

getVirtualGoods

signature getVirtualGoods()

returns JSON

validity All Scripts

Returns a list of the Virtual Goods configured against the game

getVirtualGood

signature getVirtualGood(string shortCode)

returns SparkVirtualGood

validity All Scripts

Returns the virtual good with the supplied short code

getAchievements

signature getAchievements()

returns JSON

validity All Scripts

Returns a list of the Achievements configured against the game

getAchievement

signature getAchievement(string shortCode)

returns SparkAchievement

validity All Scripts

Returns the achievement with the supplied short code

getSegments

signature getSegments()

returns JSON

validity All Scripts

Returns a list of the Segments configured against the game

getSegment

signature getSegment(string shortCode)

returns SparkSegmentType

validity All Scripts

Returns the segment with the supplied short code

getTeams

signature getTeams()

returns JSON

validity All Scripts

Returns a list of the Teams configured against the game

getTeam

signature getTeam(string shortCode)

returns SparkTeamType

validity All Scripts

Returns the team with the supplied short code

getChallenges

signature getChallenges()

returns JSON

validity All Scripts

Returns a list of the Challenges configured against the game

getChallenge

signature getChallenge(string shortCode)

returns SparkChallengeType

validity All Scripts

Returns the challenge with the supplied short code

getDownloadable

signature getDownloadable(string shortCode)

returns SparkDownloadable

validity All Scripts

Returns the downloadable with the supplied short code

getDownloadables

signature getDownloadables()

returns SparkDownloadable[]

validity All Scripts

Returns a list of all the downloadables configured for this game

getMatchConfigs

signature getMatchConfigs()

returns JSON

validity All Scripts

Returns a list of the match configurations for the game

getMatchConfig

signature getMatchConfig(string shortCode)

returns SparkMatchConfig

validity All Scripts

Returns the match configuration with the supplied short code

getCurrencies

signature getCurrencies()

returns JSON

validity All Scripts

Returns a list of the custom currency configurations for the game

getCurrency

signature getCurrency(string shortCode)

returns SparkCurrency

validity All Scripts

Returns the custom currency configuration with the supplied short code

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