diff --git a/Token-Action.md b/Token-Action.md index dc45278..935521e 100644 --- a/Token-Action.md +++ b/Token-Action.md @@ -15,9 +15,9 @@ Button functions in the top row, from left to right: * Display initiative # Configuration -### System -Sets the game system that you are using.
-This is only relevant for the displayed stats and the 'toggle condition' function (see below).
+### Game Systems +The Stream Deck application automatically detects what game system you're using, as long as Foundry is running and connected. If not, it will default to DnD 5e.
+System-specific options, such as the some 'stats' or 'on-click' options, can result in blank fields in the property inspector, when switching from a system that supports them to one that doesn't.
Currently 'DnD 5e', 'DnD 3.5e', 'Pathfinder 1e', 'Pathfinder 2e' and 'Shadow of the Demon Lord' are supported.
### Stats @@ -47,25 +47,18 @@ And use multiple stats: `STR: [@actor.data.data.abilities.str.mod] DEX: [@actor. ### On Click Determines what Foundry should do when you press the button: * Do Nothing - Does nothing +* Custom - Assign a custom on click action (see below) * Center on Token - Centers the view on the selected token * 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 * Set Token Wildcard Image - Change the token image to one of the tokens wildcard images (see below) -* Custom - Assign a custom on click action (see below) - -#### Set Token Wildcard Image -You can change the token image if you use the wildcard image option that foundry provides click [here](https://foundryvtt.com/article/tokens/) for more info on how to set up wildcard images.
-When you set 'On Click' to 'Set Token Wildcard Image' you get the two new boxes in the PI: 'Wildcard Image' and 'Value'. - -With 'Wildcard Image' you select what you want the button to do.
If it is set to 'Iterate Image' it will change the token image to a next one in the wildcard image list. How many images it iterates is set with the 'Value' input box.
-If you set 'Wildcard Image' to 'Set Image', it will set the image to the n'th image of the list, where 'n' is set using the 'Value' input box.
-By setting 'Wildcard Image' to 'Offset', you can offset the selected image by 'Value'. So if on one button you have 'Wildcard Image' set to 'Set Image' and 'Value' set to n, after pressing the button set to 'Offset', n will be n plus the offset value. +* Toggle Condition - Toggles a condition on the selected token +* Toggle CUB Condition - Toggles a [Combat Utility Belt](https://foundryvtt.com/packages/combat-utility-belt/) condition +* Toggle Initiative - Toggle the initiative (Shadow of the Demon Lord only) #### Custom 'On Click' Function Please note that this function is quite powerful, but can seriously mess up tokens and actors if you're not careful with the targets. Please make sure you fill in the correct path and create a test character to test it out on first!
@@ -114,14 +107,25 @@ If you want to modify string data, such as a token name, any part to the right o If the string contains any empty spaces, you must surround the string with square brackets '[' and ']'.
So, for example, to set the token name: `[@actor.name] = John` or `[@actor.name] = [John Doe]`. Setting it to `[@actor.name] = John Doe` will not work. -### 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. +#### Set Token Wildcard Image +You can change the token image if you use the wildcard image option that foundry provides click [here](https://foundryvtt.com/article/tokens/) for more info on how to set up wildcard images.
+When you set 'On Click' to 'Set Token Wildcard Image' you get the two new boxes in the PI: 'Wildcard Image' and 'Value'. + +With 'Wildcard Image' you select what you want the button to do.
If it is set to 'Iterate Image' it will change the token image to a next one in the wildcard image list. How many images it iterates is set with the 'Value' input box.
+If you set 'Wildcard Image' to 'Set Image', it will set the image to the n'th image of the list, where 'n' is set using the 'Value' input box.
+By setting 'Wildcard Image' to 'Offset', you can offset the selected image by 'Value'. So if on one button you have 'Wildcard Image' set to 'Set Image' and 'Value' set to n, after pressing the button set to 'Offset', n will be n plus the offset value. + +### Toggle Condition +If 'Toggle Condition' was selected at 'On Click', a dropdown menu appears with a list of conditions available in the current game system.
+ +### Toggle CUB Condition +Only works if [Combat Utility Belt](https://foundryvtt.com/packages/combat-utility-belt/) is installed and enabled.
+Allows you to toggle conditions from the CUB 'Condition Lab'. Just fill in the name of the condition in the 'Condition Name' field. + ### Display Name Toggles whether or not the button should display the token's name.