Token Action
The token action has extra features for the Token
mode, and adds new modes:
- Token Mode: New
Stats
,On Press
andOn Hold
options - Inventory Mode: Display and roll weapons and other items
- Features Mode: Display and roll actor features
- Spellbook Mode: Display and roll spells
Token Mode
The Token mode has new Stats
, On Press
and On Hold
options.
Option | Description |
---|---|
Stats | Stat to display: -HP -Temporary HP -AC -Speed -Initiative -Hit Dice -Spellcasting: Spellcasting ability, DC, modifier or spell slots. -Currency: All, or a specified type of currency. -Encumbrance -Ability Score: Ability score of a specified ability. -Ability Modifier: Ability modifier of a specified ability. -Saving Throw Bonus: Saving throw bonus of a specified ability. -Skill Bonus: Skill bonus of a specified skill. -Skill Passive: Passive score of a specified skill. -Proficiency Bonus -XP |
On Press/On Hold | Sets what to do when the button is pressed/held down: -Toggle Condition: Toggle a specified condition or clear all conditions. -Dice Roll: Roll a dice for a specified feature. |
Dice Roll
Dice Roll
allows you to roll a dice for the selected token/actor.
Option | Description |
---|---|
Roll | Type of roll: -Initiative: Roll initiative (if in combat). -Ability Check: Roll an ability check. -Saving Throw: Roll a saving throw. -Skill Check: Roll a skill check. |
Ability ( Ability Check &Saving Throw ) |
Ability to roll. |
Skill ( Skill Check ) |
Skill to roll. |
Roll Modifier (All but Initiative ) |
Roll modifier: -Default: Roll using the default roll modifier. -Normal: Normal roll. -Advantage: Roll with advantage (roll twice, take the highest). -Disadvantage: Roll with disadvantage (roll twice, take the lowest). |
Inventory Mode
The inventory mode can be used to display and control items in the token/actor's inventory.
Option | Description |
---|---|
Item Type | -Any: Select any kind of item. -Weapons: Select from weapons. -Equipment: Select from equipment. -Consumables: Select from consumable items. -Tools: Select from tools. -Containers: Select from containers. -Loot: Select from loot. -Set Type & Filter Sync: Set the synced settings for this page. Will synchronize Item Type and Selection Filter .-Offset: Set item offsets. |
Selection Filter | Selects item parameters to filter out: -Equipped: Filters equipped items. -Not Equipped: Filters unequipped items -Unequippable: Filters items that cannot be equipped. -Attuned: Filters attuned items. -Unattuned: Filters unattuned items. |
Sync Type & Filter | Will synchronize Item Type and Selection Filter for all buttons on this page with this setting enabled. |
Selection | Set how to select the item: -Select by Nr: Select an item using a number. -Select by Name/Id: Select an item using its name or id. |
Order ( Select by Nr ) |
Sets how to order the items: -Character Sheet: Follow the order of the character sheet. -Alphabetically: Order items alphabetically. |
Nr ( Select by Nr ) |
Number of the item to select. |
Name/Id ( Select by Name/Id ) |
Name or id of the item to select. |
On Press/On Hold | Sets what to do when the button is pressed/held down: -Do Nothing: Do nothing. -Use: Use (roll) the item. -Equip: Equip or unequip the item. -Set Quantity: Set the quantity of the item. -Set Charges: Set the charges of the item. |
Mode ( Equip ) |
Configure what to do: -Toggle: Toggle between equipping and unequipping item. -Equip: Equip item. -Unequip: Unequip item. |
Mode ( Set Quantity ) |
Configure how to set the quantity: -Set to Value: Set to the specified value. -Increase/Decrease: Increase or decrease the quantity by the specified value. |
Mode ( Set Charges ) |
Configure how to set the charges: -Reset: Reset the charges. -Set to Value: Set to the specified value. -Increase/Decrease: Increase or decrease the quantity by the specified value. |
Display | -Icon: Display item's icon. -Name: Display item's name. -Box: Display a box with data. -To Hit: Display the item's 'To Hit' modifier. -Damage: Display the item's damage formula. -Range: Display the item's range. |
Use Item
Using the On Press
or On Hold
Use Item
function, you can use the item by pressing/holding the button.
Option | Description |
---|---|
Show Dialog | Selected: Will show the roll dialog with all (applicable) options below pre-filled. Not selected: Will not show the roll dialog and roll the item according to the options below. |
Roll Modifier | Sets the roll modifier: -Default: Roll using the default roll modifier. -Normal: Normal roll. -Advantage: Roll with advantage (roll twice, take the highest). -Disadvantage: Roll with disadvantage (roll twice, take the lowest). |
Roll Type | Sets the roll type: -Default: Roll using the default roll type. -Attack: Perform an attack roll. -Damage: Perform a damage roll. -Critical: Perform a critical damage roll. -Use: Perform a 'use item' roll. |
Attack Mode | Sets the attack mode: -Default: Roll using the default weapon attack mode. -One-Handed: Perform a one-handed roll. -Two-Handed: Perform a two-handed roll. -Offhand: Perform an offhand roll. -Thrown: Perform a thrown roll. -Offhand Throw: Perform an offhand throw roll. |
Features Mode
The features mode can be used to display and control token/actor features.
Option | Description |
---|---|
Features Type | -Any: Select any kind of feature. -Classes: Select from classes. -Subclasses: Select from subclasses. -Backgrounds: Select from backgrounds. -Races: Select from races. -Abilities: Select from (all) abilities. -Active Abilities: Select from active abilities. -Passive Abilities: Select from passive abilities. -Set Type & Filter Sync: Set the synced settings for this page. Will synchronize Feature Type and Feature Type Filter .-Offset: Set feature offsets. |
Selection Filter | Selects feature types to filter out: -Features: Filters feature features. -Class: Filters class features -Special: Filters special features. -Action: Filters action features. -Bonus Action: Filters bonus action features. -Reaction: Filters reaction features. -Legendary Actions: Filters legendary action features. -Mythic Actions: Filters mytic action features. |
Sync Type & Filter | Will synchronize Feature Type and Feature Type Filter for all buttons on this page with this setting enabled. |
Selection | Set how to select the feature: -Select by Nr: Select a feature using a number. -Select by Name/Id: Select a feature using its name or id. |
Order ( Select by Nr ) |
Sets how to order the features: -Character Sheet: Follow the order of the character sheet. -Alphabetically: Order features alphabetically. |
Nr ( Select by Nr ) |
Number of the feature to select. |
Name/Id ( Select by Name/Id ) |
Name or id of the feature to select. |
Display | -Icon: Display feature's icon. -Name: Display feature's name. -Uses: Display the feature's uses. |
Spellbook Mode
The spellbook mode can be used to display and control token/actor spells.
Option | Description |
---|---|
Spell Type | -Any: Select any kind of spell. -Cantrip/Level: Select from the specified spell level. -Set Type & Filter Sync: Set the synced settings for this page. Will synchronize Spell Type and Preparation Mode Filter .-Offset: Set item offsets. |
Preparation Mode Filter Filter | Selects spell preparation modes to filter out: -Prepared: Filters prepared spells. -Always Prepared: Filters always prepared spells -Innate: Filters innate spells. -At Will: Filters at will spells. -Ritual: Filters ritual spells. -Pact Magic: Filters pact magic spells. |
Sync Type & Filter | Will synchronize Spell Type and Preparation Mode Filter for all buttons on this page with this setting enabled. |
Selection | Set how to select the spell: -Select by Nr: Select a spell using a number. -Select by Name/Id: Select a spell using its name or id. |
Order ( Select by Nr ) |
Sets how to order the spells: -Character Sheet: Follow the order of the character sheet. -Alphabetically: Order spells alphabetically. |
Nr ( Select by Nr ) |
Number of the spell to select. |
Name/Id ( Select by Name/Id ) |
Name or id of the spell to select. |
Display | -Icon: Display spell's icon. -Name: Display spell's name. -Uses: Display the spell's range. |
Synced Settings
You can synchronize setting across multiple buttons on the same page, where a page is all the buttons that are currently visible on the device.
If two buttons have Sync Type & Filter
selected, and you change one of the filter settings on one, the otheer button will also be changed.
Each of the modes have a Set Type & Filter Sync
setting. If you press this button, all buttons with Syn Type & Filter
will have their settings changed to what you have configured for the Set Type & Filter Sync
button.
Offset
Offsets can be used in combination with the Select by Nr
Selection Mode
.
By setting an offset, you increase Nr
for all buttons with that offset.
For example, say you have 9 Inventory Mode
buttons, with Nr
set from 1 to 9.
If you then set the offset to 9, it will display items 10 - 19.
Option | Description |
---|---|
Offset Mode | Sets how to set the offset: -Set to Value: Sets the offset to the value set in Offset .-Increase/Decrease: Increases the offset by the value set in Offset . |
Offset | The value to set the offset to (in case of Set to Value ), or the value to increment the offset with (in case of Increase/Decrease ).The offset can be any value, positive or negative. |
Display | -Offset: Display the current offset on the Stream Deck. -Icon: Display an icon on the Stream Deck. |
Colors | -On Color: (Set to Value only) A border is drawn on the Stream Deck of this color if the current offset is equal to the offset configured in Offset .-Off Color: ( Set to Value only) A border is drawn on the Stream Deck of this color if the current offset is not equal to the offset configured in Offset .-Background: Background color of the button. |