Documentation
API Reference
game-client
interfaces

Interface: TournamentCreateConfig

tournament.TournamentCreateConfig

Properties

endTime

• Optional endTime: number

Optional input for setting a custom end time for the tournament. The number passed in represents a unix timestamp.

If not specified, the tournament will end one week after creation.

image

• Optional image: string

A base 64 picture. This can be used to customize in game UI and tournament posts on Facebook in compliance with integrity rules.

Image size should be 680*340.

payload

• Optional payload: any

Developer can retrieve this data from .getPayload(). This data is immutable and optional.

score

• score: number

Score of the tournament creator

scoreFormat

• Optional scoreFormat: "NUMERIC" | "TIME"

Optional input to determine how the scores are formatted in the leaderboard. The two options are “NUMERIC” or “TIME”. “TIME” scores will still be passed in as a number representing milliseconds.

Default is “NUMERIC”.

sortOrder

• Optional sortOrder: "HIGHER_IS_BETTER" | "LOWER_IS_BETTER"

Optional input to determine if higher scores or lower scores are better in the leaderboard. The two options are “HIGHER_IS_BETTER” or “LOWER_IS_BETTER”.

Default is “HIGHER_IS_BETTER”.

title

• Optional title: string

Custom tournament title. If not specified, the game’s title will be used.