Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TournamentConfigs<ConfigType>

Internally used type.

Type parameters

  • ConfigType

Hierarchy

  • TournamentConfigs

Index

Properties

agentsPerMatch

agentsPerMatch: Array<number>

An array of valid number of players that can compete in a match. For Rock Paper Scissors for example this would be [2]

default

[2]

Optional consoleDisplay

consoleDisplay: boolean

Whether or not to display a continuous console log of the current tournament as it runs

default

true

Optional defaultMatchConfigs

defaultMatchConfigs: DeepPartial<Configs>

The default match configurations to be applied throughout all tournament matches

Optional id

id: string

Set this ID to override the generated ID

Optional loggingLevel

loggingLevel: LEVEL

The tournament wide logging level to enforce

Optional name

name: string

The name of the tournament

rankSystem

rankSystem: RankSystem<any, any> | RankSystemTypes

The ranking system to use for this tournament. Either a string or a class that extends RankSystem

rankSystemConfigs

rankSystemConfigs: any

resultHandler

resultHandler: (results: any) => any

The result handler for returning the appropriate results to the tournament for processing.

To find what kind of result should be returned, find the Results interface for the rank system you are using.

Example: For {@link Tournament.RankSystem.TRUESKILL}, go to {@link Tournament.RankSystem.TRUESKILL.Results}

Type declaration

    • (results: any): any
    • Parameters

      • results: any

      Returns any

tournamentConfigs

tournamentConfigs: ConfigType

type

type: Type

The tournament type to run. See {@link Tournament.Type}

Generated using TypeDoc