diff --git a/Token-Actions.md b/Token-Actions.md index e6897ba..f27be6f 100644 --- a/Token-Actions.md +++ b/Token-Actions.md @@ -15,24 +15,20 @@ Button functions in the top row, from left to right: * Display initiative # Configuration -### Display Name -Toggles whether or not the button should display the token's name - -### Display Icon -Toggles whether or not the button should display the token's icon - ### System Sets the game system that you are using.
This is only relevant for the displayed stats and the 'toggle condition' function (see below).
-Currently DnD 5e, DnD 3.5e and Pathfinder 2e are supported.
+Currently 'DnD 5e', 'DnD 3.5e', 'Pathfinder 1e', 'Pathfinder 2e' and 'Shadow of the Demon Lord' are supported.
### Stats You can select a stat to be displayed on the button (under the name, if 'Display Name' is selected).
You can choose between the following stats: +* None +* Custom (see below) * Hit points * Temporary hit points * Armor class -* Shield hit points (pfe2 only) +* Shield hit points (all systems except dnd5e) * Movement speed * Initiative * Passive Perception (dnd5e only) @@ -40,18 +36,40 @@ You can choose between the following stats: Some of these have their own default icon (heart for HP, shield for AC, etc) that will be displayed if 'Display Icon' is deselected. +#### Custom Stats +By selecting 'Custom', you can enter a formula to get any stat from a token by filling in the path the the desired stat (from the token object).
+For example, to get the strength modifier in dnd5e, you'd use the path `actor.data.data.abilities.str.mod`. Any stat you want to display needs to be prefixed by '@', and surrounded by square brackets '[' and ']'.
+
+So for the strength modifier, you'd fill in `[@actor.data.data.abilities.str.mod]`.
+You can add text around it: `STR: [@actor.data.data.abilities.str.mod]`
+And use multiple stats: `STR: [@actor.data.data.abilities.str.mod] DEX: [@actor.data.data.abilities.dex.mod]`
+ ### On Click Determines what Foundry should do when you press the button: * Do Nothing - Does nothing * Center on Token - Centers the view on the selected token -* Open Character Sheet - Opens the selected token's character sheet -* Open Token Config - Opens the selected token's configuration screen +* Open Character Sheet - Opens or closes the selected token's character sheet +* Open Token Config - Opens or closes the selected token's configuration screen * Toggle Visibility - Toggles the visibility of the selected token * Toggle Combat State - Toggles the combat state of the selected token * Target Token - Targets the selected token * Toggle Condition - Toggles a condition on the selected token +* Toggle Initiative - Toggle the initiative (Shadow of the Demon Lord only) +* Set Vision - Set the token's vision and lighting + +### Condition +If 'Toggle Condition' was selected at 'On Click', a dropdown menu appears with a list of conditions available in the selected system.
+Currently does not work if you've enabled Combat Utility Belt conditions. + +### Set Vision +If 'Set Vision' was selected at 'On Click', a lot of vision settings appear. They behave identical to the settings in the Vision tab the Token Configuration screen in Foundry.
+If no value is filled in, that value is not updated, so it is possible to set, for example, the 'Dim Light Radius' without affecting the 'Dim Vision' setting by keeping the 'Dim Vision' field empty. + +### Display Name +Toggles whether or not the button should display the token's name. + +### Display Icon +Toggles whether or not the button should display the icon of the selected token. ### Background -Sets the background color. The icon needs to have transparent parts (so no jpeg).
-You set the color using hexadecimal values, and it must start with '#'.
-You could use a [color picker](https://htmlcolorcodes.com/color-picker/) to find the right hex value. \ No newline at end of file +Sets the background color. The icon needs to have transparent parts (so no jpeg). \ No newline at end of file