Discipline Features

Introduction

Discipline features are used to alter or improve the behavior of a tournament, including in-game statistics, specific custom fields, maps or characters used in matches and other features.

Each discipline has its own list of discipline features. These features are defined by their name, type and options. Available features of a discipline and their options may vary over time, for example the map list of Counter-Strike GO. The same type of feature can be found several times in a single discipline, with different names.

Definition

The definition of a discipline feature is set in the discipline and describes how it affects the tournament, match or opponent settings, using the following properties:

  • name
    string
    A name used to identify a feature in a tournament.
  • type
    string
    A data type used for computing.
  • options
    object
    The configuration of the feature for the discipline according to its type.

Example

Counter-Strike GO has a map-type discipline feature with the name map. This feature lets an organizer define the map of a match game, selected from a list set on the tournament level. Below you can see that the value of the map in the match game corresponds to the key in the settings of the tournament:

tournament object
{
    "name": "Eleague Boston Major",
    "settings": {
        "map": {
            "de_dust2": "Dust2"
        }
    }
}
match object
{
    "id": "618954615761465416",
    "opponents": [],
    "games": [
        {
            "number": 1,
            "opponents": [],
            "properties": {
                "map": "de_dust2"
            }
        }
    ]
}

Types

Each discipline feature has a type that defines its options. Here is an exhaustive list of the currently available discipline features, by category:

Common
Special
Game-specific

Character

The character feature applies on the match game opponents level. List of characters is defined in the choices option, and can be edited in the tournament settings if the settings_enabled option is TRUE.

Options:

  • choices
    object
    An associative array with the key as machine name, and value as label. This option can be empty.
  • settings_enabled
    boolean
    When TRUE, choices option can be edited in the tournament settings.

Duration

The duration feature is a time field, declared on a match game.

Options:

No options.


Map

The map feature applies on the match game level. List of maps is defined in the choices option, and can be edited in the tournament settings if the settings_enabled option is TRUE.

Options:

  • choices
    object
    An associative array with the key as machine name, and value as label. This option can be empty.
  • settings_enabled
    boolean
    When TRUE, choices option can be edited in the tournament settings.

Mod

The mod feature represents a gametype that applies on the match game level. List of mods is available in options choices.

Options:

  • choices
    object
    An associative array with the key as machine-name, and value as label.

Game Player ID

The game player id feature enables a player identifier custom field in the tournament. It adds the associated custom fields in the list of available custom fields, see Custom Fields - Games.

Options:

  • field
    string

    Identifier of custom fields.

    Possible values: battle_net, blood_bowl2, epic, maniaplanet, nintendo_network, origin, psn, smite, steam, summoner, uplay, wargaming, xbox_live

    added_by_default
    boolean
    When TRUE, the custom field is added during the tournament’s creation.
    default_label
    string|null
    Label of the custom field when added_by_default is TRUE.
    default_required
    boolean
    When TRUE, makes the custom field mandatory when added_by_default is TRUE.
    default_public
    boolean
    When TRUE, makes the custom field public when added_by_default is TRUE.

Metric

The metric feature alters the match outcome via the match format, and is applied on the match game opponents level.

Options:

  • field
    string

    Type of metric field, determines which outcome field core will be influenced.

    Possible values: score, rank


HS Pick Ban

A pick-ban feature initially created for the game Hearthstone, when this feature is available in a discipline, it adds hs_pick_choice in the list of available custom fields, see HS item pick (Custom Fields). Is applied on match opponents level.

Options:

  • feature_name_provider
    string

    Designates the feature on which the pick and ban is based.

    Support feature types: map, character

    icon_dir
    string
    Dirname of icons feature provider, to have an absolute path look like /disciplines/{discipline_id}/{icon_dir}/{key}.png.

Counter-Strike GO stats

Enables the recovery of Counter-Strike GO statistics.

Options:

  • providers_available
    array
    An array containing the list of statistical services recognized by Toornament.

League Of Legends stats

Enables the recovery of statistics from the Riot League of Legends API.

Options:

No options.


League Of Legends Tournament Code

Enables the Tournament Code system of League Of Legends.

Options:

No options.