Interface SettableTournamentValues

All properties that can be set with Tournament.settings.

See TournamentValues for detailed descriptions of properties.

interface SettableTournamentValues {
    colored?: boolean;
    matches?: Match[];
    meta?: {
        [key: string]: any;
    };
    name?: string;
    players?: Player[];
    round?: number;
    scoring?: {
        bestOf?: number;
        bye?: number;
        draw?: number;
        loss?: number;
        tiebreaks?: (
            | "median buchholz"
            | "solkoff"
            | "sonneborn berger"
            | "cumulative"
            | "versus"
            | "game win percentage"
            | "opponent game win percentage"
            | "opponent match win percentage"
            | "opponent opponent match win percentage")[];
        win?: number;
    };
    sorting?: "none" | "ascending" | "descending";
    stageOne?: {
        consolation?: boolean;
        format?:
            | "single-elimination"
            | "double-elimination"
            | "stepladder"
            | "swiss"
            | "round-robin"
            | "double-round-robin";
        initialRound?: number;
        maxPlayers?: number;
        rounds?: number;
    };
    stageTwo?: {
        advance?: {
            method?: "points" | "rank" | "all";
            value?: number;
        };
        consolation?: boolean;
        format?: "single-elimination" | "double-elimination" | "stepladder";
    };
    status?:
        | "setup"
        | "stage-one"
        | "stage-two"
        | "complete";
}

Properties

colored? matches? meta? name? players? round? scoring? sorting? stageOne? stageTwo? status?

Properties

Optionalcolored

colored?: boolean

Optionalmatches

matches?: Match[]

Optionalmeta

meta?: {
    [key: string]: any;
}

Optionalname

name?: string

Optionalplayers

players?: Player[]

Optionalround

round?: number

Optionalscoring

scoring?: {
    bestOf?: number;
    bye?: number;
    draw?: number;
    loss?: number;
    tiebreaks?: (
        | "median buchholz"
        | "solkoff"
        | "sonneborn berger"
        | "cumulative"
        | "versus"
        | "game win percentage"
        | "opponent game win percentage"
        | "opponent match win percentage"
        | "opponent opponent match win percentage")[];
    win?: number;
}

Optionalsorting

sorting?: "none" | "ascending" | "descending"

OptionalstageOne

stageOne?: {
    consolation?: boolean;
    format?:
        | "single-elimination"
        | "double-elimination"
        | "stepladder"
        | "swiss"
        | "round-robin"
        | "double-round-robin";
    initialRound?: number;
    maxPlayers?: number;
    rounds?: number;
}

OptionalstageTwo

stageTwo?: {
    advance?: {
        method?: "points" | "rank" | "all";
        value?: number;
    };
    consolation?: boolean;
    format?: "single-elimination" | "double-elimination" | "stepladder";
}

Optionalstatus

status?:
    | "setup"
    | "stage-one"
    | "stage-two"
    | "complete"

Settings

Member Visibility

On This Page

Properties