Use this list when you know what you want to do but do not know which step to pick. Read When to use it first. You do not need to memorize all 30 steps; the editor lists those available for that part of the sheet.
Search by name, group or purpose: bonus, health, choice, image, card… The steps available in the editor depend on where you opened the automation.
33 / 33 nodes found
Start
TriggerRule that follows the sheet
Where the automation starts being calculated.
When to use it
Start a rule that calculates a bonus, shows a field or maintains an effect while a condition applies.
What to configure
The editor creates this step by itself in rules that always apply. Connect the Next output to the first question, calculation or result.
Example
Start → If → Bonus calculates a conditional bonus.
Also check
Each rule has a single Start. It does not respond to clicks and does not perform actions such as spending points.
Trigger
TriggerRule started by an action
Runs the automation when the event happens.
When to use it
Start a rule when a player uses something, equips a card or makes the selected roll.
What to configure
Check the event and its source when available. For context menus, set the option's location, label and visibility.
Example
On use → Change value spends ability points.
Also check
If the event or source is different, the rule does not start. What $event offers depends on the chosen event.
If
LogicRule that follows the sheetRule started by an action
Goes to Yes or No depending on the condition.
When to use it
Split a rule into two paths, such as having enough Mana or not having enough.
What to configure
Set a condition using the visual builder or an expression, then connect Yes and No to their paths.
Example
@vida > 0 follows Yes when the character has health remaining.
Also check
Only one path runs. A path with no line simply ends.
Switch
LogicRule that follows the sheetRule started by an action
Several paths: follows the case that matches, or Default.
When to use it
Choose among several situations, such as different bonuses for several levels.
What to configure
Add cases and their conditions, then choose First case or All cases. Connect Default for a fallback.
Example
Case @nivel >= 10 returns 3; case @nivel >= 5 returns 2; Default returns 1.
Also check
Cases are evaluated in configured order. First uses the first true case; All may perform several actions. Put the most specific case first.
Store value
DataRule that follows the sheetRule started by an action
Stores a value for the next steps.
When to use it
Store a result for later steps or remember a counter between uses.
What to configure
Choose the name, the value and the scope: Local or Sheet memory. Numbers can be read as @name; the Step name lets other steps read the result with $("Step name").
Example
Name cost, value 2: later steps can use @cost. Read text with $("Step name").
Also check
In passive card effects, numbers and yes/no values become sheet variables while the effect is active. Sheet memory scope also makes text, lists and records available in $sheet.memory while the passive effect is active, preserving saved memory. In other calculations, the value stays local. In rules with a Trigger, memory persists between runs; storing null deletes the value.
Read original item
DataRule that follows the sheetRule started by an action
Reads the item this modification is attached to. Returns empty outside a modification.
When to use it
Read the item carrying a modification so its effects can use that item's data.
What to configure
This step has no parameters. Read its output by the step name, or use $self.parent inside the modification's automation.
Example
$("Read original item").schemaValues.damage reads the damage property of the item carrying the modification.
Also check
Without a parent item, the result is empty (null). The read returns a plain snapshot with no further parent and does not change the original item.
Filter list
DataRule that follows the sheetRule started by an action
Takes a sheet list (skills, attributes...) or any list and keeps the items that match a condition.
When to use it
Keep only the items you need, such as equipped cards from all the sheet's cards.
What to configure
Choose the source list and, if you want, a question asked for each item. In a custom list, you can use the list another step returned or write a list yourself.
Example
Resources filtered with $item.equipped == true returns only equipped cards.
Also check
Inside the filter, $item is the item being looked at. With no filter, every item passes. If the source does not exist, the result is an empty list.
Sum or count
DataRule that follows the sheetRule started by an action
Sums, counts or takes the min/max of a list.
When to use it
Count items in a list or calculate its sum, average or another result.
What to configure
Provide the list, operation and field when aggregating record properties. Operations include Count, Sum, Min, Max, Average, First and Last.
Example
List $("Equipped"), Sum and field quantity adds the filtered cards' quantities.
Also check
For an empty list, Count and Sum give 0; the other operations are empty (null). To add up a number from each item, give the field, such as quantity.
Bonus
ResultRule that follows the sheet
Sets the bonus this automation gives.
When to use it
Provide the number for the bonus or modifier you are configuring.
What to configure
Provide a fixed number or expression for the bonus or modifier calculated by this editor.
Example
if(@nivel >= 5, 2, 1) gives 2 from level 5 onwards and 1 before that.
Also check
If the path goes through two Bonus steps, the last one wins. To add parts together, do the sum in a single expression.
Show or hide
ResultRule that follows the sheet
Shows or hides the block.
When to use it
Show or hide the block receiving this rule.
What to configure
Set Show or Hide using a fixed value or an expression producing true/false.
Example
@vida > 0 shows the block only while health remains.
Also check
Controls the block in this context. Use Field visibility for an individual field when available.
Field visibility
ResultRule that follows the sheet
Shows or hides a field.
When to use it
Show or hide a particular field in a block that supports it.
What to configure
Choose the target field and its visibility condition or fixed value.
Example
Show an ammunition field only while a firearm option is active.
Also check
Pick the target through the sheet selector. Field visibility depends on the block supporting that capability.
Modify field
ResultRule that follows the sheet
Changes a field while the automation applies.
When to use it
Apply an effect to a field, such as extra defense while a shield is equipped.
What to configure
Choose target, Set/Add/Subtract, value and application. Selectors may require an option or position; vitals may require current or maximum.
Example
Add 2 to defense while a shield is equipped.
Also check
While active keeps the effect only while the rule applies and removes it afterwards. On activation applies once and does not undo; be careful not to make a permanent change by accident.
Text
ResultRule that follows the sheet
Shows a text in the block.
When to use it
Display text on the block, such as a status notice or bonus explanation.
What to configure
Write the text and, if available, choose the tone. In expression mode, put calculated values between {{ and }}.
Example
Text: Extra defense: {{ @bonus_escudo }}.
Also check
A result displayed in the block; it does not open a window or ask the player a question.
Item category
ResultRule that follows the sheet
Changes the category of an item block.
When to use it
Make a block use a resource category, such as a class's spell list.
What to configure
Choose the resource category and its receiving block or target. Configure filters if offered by the editor.
Example
A class option makes a block display the corresponding spell category.
Also check
Only available in contexts supporting resource categories. Changing a category does not grant a card.
Temporary card
ResultRule that follows the sheet
Adds a card while it applies.
When to use it
Add a card through a rule, such as an ability from an active option.
What to configure
Choose category, card and application: temporary or granted.
Example
An active option temporarily adds an ability card.
Also check
Temporary lasts while the effect applies; granted retains the card according to the context's application. Check the mode for provisional benefits.
Theme
ResultRule that follows the sheet
Changes the sheet theme while it applies.
When to use it
Maintain a different appearance while a rule applies, such as transformation colors.
What to configure
Choose a theme property, a ready-made theme or the option to go back to the default, using the editor controls.
Example
An active transformation changes the sheet's colors and appearance.
Also check
A theme effect while the rule applies. It does not change character numbers.
Image
ResultRule that follows the sheet
Replaces a sheet image while it applies.
When to use it
Display a different portrait or background while a condition is active.
What to configure
Choose Character photo or Canvas background and an image file.
Example
The sheet shows another portrait while an alternate form is active.
Also check
A visual override for the active context; choose an image suitable for its target.
Roll dice
ActionRule started by an action
Rolls a dice formula.
When to use it
Make a new roll, such as the attack of an ability the player uses.
What to configure
Provide the formula, source label and public or hidden visibility. Configure mode and advanced options when needed.
Example
1d20 + @forca_mod. A later step can read $("Roll dice").total.
Also check
Performs a new roll. An empty formula skips the step. A hidden roll can still supply later steps.
Add to roll
ActionRule started by an action
Adds a part (e.g. +1d4) to the roll this automation answers, before the result.
When to use it
Add dice or another part to a roll already being made.
What to configure
On a card responding On roll, provide the formula part and an optional source label.
Example
+1d4 adds a die to the responding roll; 1d4 without an operator also adds.
Also check
Happens before the result. It does not make a new roll and only works in On roll rules. If the part starts with +, -, * or /, that sign is kept.
Replace roll
ActionRule started by an action
Replaces the formula of the roll this automation answers, or cancels the roll, before the result.
When to use it
Replace the formula of a roll being made, or cancel it.
What to configure
On a card responding On roll, choose to replace the formula or cancel the roll. Replacement requires a new formula.
Example
Replace 1d20 with 2d20k1 for a rule using the higher of two dice.
Also check
Replacing the formula drops what other steps added before this one; anything added afterwards joins the new formula. Cancel prevents the roll.
Roll result
ActionRule started by an action
Shows a label and a description on the last roll's card.
When to use it
Change the title, description or appearance of a roll's result.
What to configure
Set the label, description, tone and presentation elements offered by the editor.
Example
After rolling, show “Fire attack” and a description on the result card.
Also check
Changes the presentation of the last roll; it does not create dice or change its total.
Change value
ActionRule started by an action
Changes a sheet value once.
When to use it
Change a sheet value when an action runs, such as spending Mana or restoring Health.
What to configure
Pick the sheet target and Set/Add/Subtract. The target may also come from an expression. Check vital parts and selector options.
Example
Subtract 2 from current mana when the player uses an ability.
Also check
Changes the field once. The value does not go back by itself afterwards. If the target is not found, the change is ignored and the test shows a warning.
Give card
ActionRule started by an action
Puts a card in the character's resources.
When to use it
Give the character a card when an action happens.
What to configure
Choose category, card, quantity and application: grant or temporary.
Example
Using an ability grants a resource card to the character.
Also check
Grant gives the card when the action happens. Temporary keeps the card only while the rule that gave it still applies, such as while an on/off button is switched on.
Change card property
ActionRule started by an action
Change a property or uses of a selected card or list of cards from a schema.
When to use it
Change properties and uses on sheet cards without creating a separate target for each item.
What to configure
Provide a card, its ID or a list of cards and the property's stable key. Choose Value, Current or Maximum and the Set, Add or Subtract operation.
Example
Use the card from $("Choose"), property uses, part Current and Subtract 1 to spend one use.
Also check
The entire batch is validated before any card changes. Missing and temporary cards, internal fields and invalid options are rejected; formulas still control calculated fields.
Run card automations
ActionRule started by an action
Waits for the cards present to finish their automations and receives their adjustments.
When to use it
Gather adjustments published by other cards' automations before continuing the flow.
What to configure
Choose use or roll automations. Empty Cards includes all cards present; provide IDs or records to restrict them. Source filters the call and Context adds event data.
Example
Run the equipped cards' roll automations and use the numeric values they publish in the following steps.
Also check
Automations run in order and the call waits for completion. Errors stop the caller; recursion into the same automation is rejected and each execution allows up to 64 calls.
Show message
InteractionRule started by an action
Opens a window with text and, optionally, choices.
When to use it
Show a message to the player or offer buttons with different paths.
What to configure
Provide title, body, fields, appearance and choices as needed. Each choice can have its own path.
Example
A message offers “Attack” or “Defend”, each leading to an action.
Also check
The step returns the chosen button, or empty (null) if the player closes the message. Careful: Next runs after the message whether or not a choice was made; do not put on it something that should only happen for one option.
Ask
InteractionRule started by an action
Asks for an answer, multiple choices, or a form with mixed field types.
When to use it
Ask the player for a number, text, confirmation or an answer from options.
What to configure
Write the question and choose Number, Text, Confirmation, a choice between text options or Columns. With Columns the player picks one option for each column at once, and an option used in one column cannot be used in another (e.g. columns Target and Effect, options $("Roll").dice). Connect Answer and Cancel.
Example
Ask “How much healing?” receives a number for the next step.
Also check
Read the answer with $("Ask"), with nothing after it. With Columns, read each column by its title: $("Ask")["Target"]. Cancel returns empty (null). Declining a confirmation also follows the Cancel path.
Choose
InteractionRule started by an action
The player picks a skill, attribute, vital, card or one of your options; the next steps use the choice.
When to use it
Let the player select a skill, attribute, value, card or rule option.
What to configure
Choose Skills, Attributes, Vitals, Cards or custom Options. Set title, help, per-item filter and cancellation availability.
Example
Choose a skill and use $("Choose").targets.misc as its miscellaneous bonus target.
Also check
The Chosen output returns the chosen item; Cancel returns nothing. What you can read from the item depends on its type (skill, card…).
Open page
ActionRule started by an action
Shows a sheet page on top.
When to use it
Open a sheet page over the current one for quick reference.
What to configure
Choose the sheet page to open as an overlay.
Example
A button opens the spell page for reference.
Also check
Select an existing sheet page. Opening it does not change its fields.
Play sound
ActionRule started by an action
Plays an audio file.
When to use it
Play audio when an ability or another action happens.
What to configure
Choose audio, volume and audience: yourself or campaign when available.
Example
An ability action plays a sound to accompany its effect.
Also check
Use a valid audio file. Campaign audience depends on table context and permissions.
Open file
ActionRule started by an action
Opens an image, audio or video in the preview.
When to use it
Open a file for reference, such as an image, map or video.
What to configure
Choose the file that will open in the viewer.
Example
A button opens a map image or an ability video.
Also check
Opens media. It does not grant a card or write a sheet field.
Change theme
ActionRule started by an action
Changes the sheet theme.
When to use it
Change the sheet's appearance when an action runs.
What to configure
Choose Set property, apply a ready-made theme or Reset, and fill in the controls that appear.
Example
An action changes sheet appearance when a transformation is used.
Also check
Happens once, when the action is used. To keep an appearance only while a condition applies, use the Theme step in a rule that begins at Start.
Swap image
ActionRule started by an action
Swaps the character photo or the canvas background.
When to use it
Change the character's photo or background when an action happens.
What to configure
Choose Character photo or Canvas background and the file to apply.
Example
An action changes the portrait when a form is activated.
Also check
Check the chosen image. To swap the image only while a rule applies, use the Image step in a rule that begins at Start.