Reference
Commentary lines
A line of match commentary: when it can be said (trigger and condition), how often against the other lines for the moment (weight) and the text.
- Content type
commentary- Files
data/commentary/- Shape
- A list of records, each with its own
id - Patch target
commentary:<id>, for examplecommentary:core.commentary.tpc3- In the base game
- 188 records
- Guide
- Match commentary
Fields#
Indented fields belong to the field above them. [] marks the items of a list. A field that is not required may be left out; the default is used.
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
id | id | Yes | Namespaced id, e.g. "core.player.rory-calder" | |
trigger | one of the options | Yes | The moment it's for (see Match commentary for when each fires). Options: 180, matchStart, legStart, ton40, ton, steadyScore, visit, onAFinish, lowScore, bust, tonPlusCheckout, maxCheckout, checkout, breakOfThrow, missedDoubles, missedMatchDart, nineDarterOn, nineDarter, setWon, matchWon, conductWarning, legDocked, matchForfeited, winByTwo, suddenDeath. | |
condition | object | Only when these hold (all optional). | ||
condition.minN180 | whole number | The player has thrown at least this many 180s in the match (this one included). | ||
condition.maxN180 | whole number | …at most this many. | ||
condition.minScore | whole number | The score (the visit, or the checkout) is at least this. | ||
condition.maxScore | whole number | …at most this. | ||
text | text | Yes | What the commentator says. Placeholders: {player} {opponent} {score} {n180} {checkout} {darts} {legs} {avg}. | |
weight | number, at least 0 | 1 | How often it's picked against the other lines for the moment (0 = never). |
Example#
A record from the base game’s data/commentary/en.json.
{
"id": "core.commentary.tpc3",
"trigger": "tonPlusCheckout",
"condition": {
"minScore": 130
},
"text": "{checkout}! That’s one of the finishes of the night.",
"weight": 2
}In your pack the record’s id starts with your pack’s id instead of core, unless you mean to replace this one.