Rulebook tables

What a table is

A rulebook table is fixed data that your rules read, such as a bonus for each calling. It is not play state, and players never change it. Changing a row makes a new version of your game, like any other edit to the source.

Declare a table

A table is a JSON file in tables/. List it in the manifest.

  "tables": ["tables/callings.json"]

{
  "id": "callings",
  "name": "Callings",
  "columns": [
    { "key": "calling", "label": "Calling", "type": "string" },
    { "key": "bonus", "label": "Watch bonus", "type": "number" }
  ],
  "rows": [
    { "calling": "Guard", "bonus": 30 },
    { "calling": "Scout", "bonus": 10 }
  ]
}

A Framework lists the ids of the tables it reads.

  "tables": ["callings"]

Read a table in a rule

table.find takes the table id, the columns to match with the values to look for, and the columns to return with a default for each. It returns the columns you name, from the first row whose match columns all equal your values. When no row matches, it returns your defaults.

export function construct(
  name: string,
  max_hp: number,
  calling: string,
): { name: string; max_hp: number; hp: number; calling: string; watch: number } {
  const row = table.find("callings", { calling: calling }, { bonus: 0 });
  const bonus: number = row.bonus;
  return {
    name: name,
    max_hp: max_hp,
    hp: max_hp,
    calling: calling,
    watch: 20 + bonus,
  };
}

The table id is a string written in the code, and the Framework must list the table. Every column you name must exist, and only the columns you name come back. A constructor reads a table this way. The values to match must be a variable, a field or a literal, not a computed value.

These mistakes are caught when you check the project:

  const row = table.find("callings", { calling: calling }, { boost: 0 });

has no column 'boost'

which manifest.tables does not declare

  const row = table.find("callings", { calling: calling + "!" }, { bonus: 0 });

table.find match values must be a variable, a field or a literal

Use a table for choices

A text input can take its choices from one column of a table. The choices are the distinct values of the column, in row order.

    "calling": {
      "label": "Calling",
      "optionsFrom": { "table": "callings", "column": "calling" },
      "defaultValue": "Guard"
    }

is not one of this Framework's tables

An action input of type text can do the same with an optionsFrom entry in the action's declaration. A source must offer at least 2 choices.

Next