Inline checks

Inline checks

You can add inline checks to certain text fields like the chat, journals, or enriched text fields within actors and items.

An inline check always starts with @check (or @Check) followed by certain arguments. The general structure looks like this @check[aspect|{roll: config}](roll name) and will be explained in more detail below.

In text a check will look like this:

SHIFT-clicking an inline check will skip the roll config window and directly roll to chat

CTRL-clicking an inline check will post a copy to the chat

Aspect

The first and only required argument is the aspect. You can define them using their name, so for example, a courage check would look like this @check[courage]. Should their name include a white space " ", you need to replace it with a "_". Let's, for example, say your story has a story aspect named "Ghost Stormers Lore", you would need to write @check[ghost_stormers_lore].

As the story aspects might be language dependent, you can also use their position in the story's spect list. Remember that in programming the first item is "0", so rolling a check for the first story aspect would look like @check[0].

Note that for core checks you should always use the English words (courage, evade, fight, luck, perception).

Roll name

A roll name is optional, but often makes the rolls easier to understand. You can specify it in "()" behind the check. If, for example, you want a courage check, but not show the players what type of check it is, you may use @check[courage](Mystery check).

If no roll name is specified, the check will default to "Aspects check" or replace the "Aspect" with the specific name in case of core checks.

Roll config

The roll config allows you to specify certain roll options. They are specified in JSON format, so follow a pattern of {key : value}. Other than normal JSON, you do not need to put the keys and values in "". Allowed keys are listed below, an arbitrary number of them may be combined ({key1 : value1, key2 : value2}):

• flaws: Specifies an array of flaws for the check, example: @check[courage|{flaws : ["Flaw 1", "Flaw 2"]}] (the flaw names have to be put in "")
  • You can also mark certain flaws as omen flaw as such: @check[courage|{flaws : [{name : "Flaw 1", isomen : true}, "Flaw 2"]}]
  • As a short hand you can also add omen flaws as such @check[courage|{omenflaws : ["Flaw 1"], flaws : ["Flaw 2"]}]
  • To quickly add a generic omen flaw you can also use @check[courage|{omenflaw : true}]
• edges: Spacifies an array of edges for the check, the same as flaws: @check[courage|{edges: ["Edge 1", "Edge 2"]}] (the edge names have to be put in "")
• strain: To add a strain to a check: @check[courage|{strain : true}]
• ignoreStrain: To ignore strain on a check: @check[courage|{ignoreStrain : true}]
• targetNumber: To set the target number for a check: @check[courage|{targetNumber : 0}]
• taskDifficulty: To set the task difficulty of the check: @check[courage|{taskDifficulty : 2}]
  • You can also use the following words instead of numbers for the task difficulty: veryeasy, easy, average, hard, veryhard
• taskRisk: To set the risk of the check, possibilities being harmless, normal, risky, for example: @check[courage|{taskRisk : risky}]
• woundThreshold: To set the minimum face on omen dice that can cause wounds (default is current act), example: @check[courage|{woundThreshold: 6}]
• strainThreshold: To set the minimum face on omen dice that can cause strains (default is current act), example: @check[courage|{strainThreshold : 6}]
• rollbehaviour: Allows for certain ways the roll works to be modified, multiple options can be combined:
  • redrawomendice: How often the drawn omen dice can be redrawn (new dice will be rerolled): @check[courage|{rollbehaviour : {redrawomendice: 1}}]
  • rerolls: How often the dice can be rerolled (rerolls will create a new roll and leave the old roll): @check[courage|{rollbehaviour : {rerolls: 1}}]
  • flawhnl: If this check is rolled with flaws, instead of using the lowest two results, the highest and the lowest roll will be used: @check[courage|{rollbehaviour : {flawhnl: true}}]
  • edgehnl: If this check is rolled with edges, instead of using the highest two results, the highest and the lowest roll will be used: @check[courage|{rollbehaviour : {edgehnl: true}}]

For common options there is also short hand:

• omenflaw : of
• taskDifficulty : tD
• taskRisk : tR