| Expand | ||
|---|---|---|
| ||
|
...
One automation action per line.
A description text string that determines where the double click action is placed within the ability description text. This text also determines where automation guideline square brackets [ .. ] are inserted in the descriptive text to indicate where the action can be initiated by double-clicking. This text is enclosed in double-quotes: “ .. “
The action code to execute when the description text is double-clicked. This is separated from the description text by a pipe | symbol. Include the pipe symbol even if the description text match isn’t being used.
| Info |
|---|
NOTE: The automation data is read when the Automation field loses focus - tab out or click outside of the field. When adding new automation, or editing existing automation, make sure you exit the automation field so that the automation parsing code will run and assign the data to the text in the ability description. |
For example:
"blinded"|Effect: Blinded [SELF]
This creates a double-click effect action on the first occurrence of blinded in the ability description:
...
Each automation action is detailed below. Fields highlighted in blue are optional.
Attack
The attack action takes the same format as the normal attack text within an NPC record.
Melee attack is assumed unless the action string begins with “Ranged ”
Standard targeting is used.
[CD] - auto apply any Cooldown action attached to this ability when this action is used.
[USE] - auto reduce the [USES: XX] tag in the ability title by one when this action is used.
Format:
Attack: Ranged <standard attack string>[CD][USE]
For example:
Attack:jaws +6 (agile, finesse) - makes a melee attack with the listed traits.
Attack:Ranged jaws +6 (agile, finesse, range increment 20 feet) - makes a ranged attack with the listed traits.
...
Format:
Damage:<damage string including damage types>[CD][USE][SELF][TRAITS: abc]
For example:
Damage:1d4 piercing plus 1d4 fire
Damage: 1d6 piercing[TRAITS: deadly d8] - adds the “deadly d8” trait to the damage action.
...
Targeting - standard targeting will be used unless one of the following is specified.
Standard targeting is used unless [SELF] is used in the action string. Not supported (ignored) if a success level tag is used.
[TOSELF] applies the effect to the targets but then targets the effect back to the NPC. Not supported (ignored) if a success level tag is used. R19
[TOTARGETS] applies the effect to the targets actor but then targets the effect back to the NPCtargets. Not supported (ignored) if a success level tag is used. R19 Use targeting to apply, not drag/drop.
Specify the duration of the effect with the [D:XX] tags - where XX is the duration in rounds. No duration tag means the effect is indefinite. XX can be a dice string - e.g. 1d4+2. The dice string is evaluated using random numbers, not an actual dice roll.
Optional: [MINS] or [HOURS] -the effect duration is specified in minutes or hours not rounds. [HOURS] results in the duration in the combat tracker being set to 0 as hour/s long effects aren’t currently tracked.
To specify that the duration decrements at the end of the turn use [END]. If not specified the default of the start of the turn will be used.
To indicate an optional DC associated with the effect use [DC:YY{F}] - where YY is the DC related to the effect. An optional F can be added (without the curly brackets) to specify a flat check - e.g. [DC:20F] for a DC 20 flat check.
[CD] - Optional.. Auto apply any Cooldown action attached to this ability when this action is used.
[USE] - Optional. Auto reduce the [USES: XX] tag in the ability title by one when this action is used.
The Init value to reduce the duration will be the current init value when the effect is applied.
[ACTION], [ROLL] or [SINGLE] - Optional. When to expend the effect, after an action, a roll or expend each effect once it’s been used.
[GM] - Optional. Effect = GM only. Indicates that the player won’t see the application of the effect in the chat window, nor will they see the applied effect in the combat tracker.
[<success level>] - Optional. When a save or attack has been rolled for this action and an ApplyAllEffects action is triggered, this success level will be matched to the save success level stored for each target. Supports multiple success level values per effect with each level within a pair of square brackets in the format: [CRITSUCCESS], [SUCCESS], [FAILURE], [CRITFAILURE] or [ALL]. Note: an effect action with a success level tag doesn’t support the [SELF] tag, it will be ignored - success levels are designed for targets other than self only.
Format:
Effect:<effect string>[D:XX][SELF][END][DC:YY{F}][CD][USE][GM][<success level>]
| Info |
|---|
Note: [DC:] must come before [D:] currently. |
...
Standard targeting is used unless [SELF] is used in the action string.
Indicate a basic save (half damage on success, no damage on critical succes, etc.) with the [BASIC] or [HALF] tags. Adds the “basic” trait to the save action.
Save traits are automatically extracted from the traits in the ability title - contained within brackets ( .. ) in the ability title, no need to add anything to the automation code.
Additional traits can be added to the traits already extracted from the ability title using the [TRAITS: aaa, bbb, cccbbb] tag, where aaa, bbb, ccc are comma separated trait names.
Specify the DC of the save with the [DC:XX] tags - where XX is the target DC. This is required.
Specify the type of save immediately after the “Save:” action header: fortitude, reflex or will.
[CD] - auto apply any Cooldown action attached to this ability when this action is used.
[USE] - auto reduce the [USES: XX] tag in the ability title by one when this action is used.
Format:
Save:<type>[DC:XX][SELF][HALF][BASIC][TRAITS:aaa, bbb, ccc][CD][USE]
For example:
Save:reflex[DC:18][BASIC] - perform a basic reflex save with a target DC of 18. Standard targeting is used.
Save:fortitude[DC:22][SELF] - The actor performs a DC 22 fortitude save.
Save:reflex[DC:18][BASIC][TRAITS:divine]- perform a basic reflex save with a target DC of 18. Standard targeting is used. The trait “divine” is added to any traits already present in the ability title.
...
Format:
VsDC:<type>:vs:<target DC type>[SELF][TRAITS:aaa, bbb, ccc][CD][USE]
Example:
VsDC:Athletics:vs:FORT Will perform an athletics check vs. the target's FORT DC.
...
<link record type> - the type of record to open. Currently supported:
spell - uses reference.spells.<db record name>@* for anonymous link matching
<record name> - The name of the record - this will be converted to XML safe naming to make an anonymous match to the module record.
Format:
openlink:<link record type>:<record name>
...