Combat Tracker Action
The combat tracker action allows you to control Foundry's combat tracker, and display combatants.
Foundry allows for multiple simultaneous encounters, these can be categorized in 2 types:
- Linked Encounters: Encounter that are linked to a specific scene. Only visible if you're on that scene.
- Unlinked Encounters: Encounters that are not linked to a specific scene. Visible from all scenes.
Under the Encounter option you can specify the kind of encounter you want to control.
Since multiple encounters can be active at the same time, you can select a specific encounter using the Encounter Nr option.
| Option | Description |
|---|---|
| Title | If configured, will set the title/text on the button. This will override any other text that would normally be displayed. |
| Icon Override | Url to a custom icon. If configured, this will override any icon that would normally be displayed. |
| Page-Wide Encounter | All combat tracker actions on the current page with this setting enabled will share the same encounter selection. So if on one of these actions you select an encounter using Encounter on a Scene, all other actions with Page-Wide Encounter enabled will also select that encounter. |
| Encounter | Encounter selection: -Active Encounter: The encounter that is currently open in Foundry. -Encounter on a Scene: Select an encounter on a specific scene. -Unlinked Encounter: Select an unlinked encounter. |
| Scene Selection | (Encounter on a Scene only) Sets how to select a scene:-Visible Scenes: Select a scene from the ones that are currently visible in the navigation bar. -Any Scene: Select any scene on the Foundry server. -Select From List: Select from a list of all scenes. -Select by Name/ID: Select a scene by its name or ID. -Active Scene: Selects the currently active scene. |
| Scene Nr | (Encounter on a Scene and Visible Scenes or Any Scene only) Number of the scene to select, see here. |
| Scene | (Encounter on a Scene and Select From List only) List of all scenes. |
| Scene Name/ID | (Encounter on a Scene and Select by Name/ID only) Name or ID of the scene to select. |
| Encounter Nr | (Encounter on a Scene and Unlinked Encounter only) The encounter to select. |
| Mode | Mode of the button: -Combatants: Display combatants. -Current Combatant: Display the current combatant. -Control: Control the combat tracker. |
Combatants & Current Combatant Mode
With the Combatant mode you can display the combatants of the combat tracker, while the Current Combatant mode displays the current combatant (with an optional offset).
| Option | Description |
|---|---|
| Disposition Filter | Filter displayed combatants based on their disposition: -All Tokens: Display any token. -Friendly & Neutral Tokens: Only display friendly or neutral tokens. -Friendly Tokens: Only display friendly tokens. -Hostile Tokens: Only display hostile tokens. |
| Hide Mode | Configure what to do with tokens that are filtered out with Disposition Filter:-Remove: Remove tokens from the displayed combatants. -Blacken Button: Display a black button with no text. -Display Mystery Man: Display a 'Mystery Man' icon. -Hide Token Name: Only hide the token name. |
| Offset | (Current Combatant Mode only) Can be used to offset the displayed combatant, for example to display the next combatant (if set to 1) or the previous combatant (if set to -1). |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if it's the combatant's turn. -Off Color: A border is drawn on the Stream Deck of this color if it's not the combatant's turn. -Background: Background color of the button. |
| All other settings | All other settings are related to the token (Stats, On Press, etc) and are identical to the Token Action. |
Control Mode
With the control mode you can control the combat tracker.
| Option | Description |
|---|---|
| Function | Function of the button: -Start/Stop Combat: Start or stop the combat. -End Turn: End your turn (mainly meant for players). -Next Turn: Go to the next turn. -Previous Turn: Go to the previous turn. -Next Round: Go to the next round. -Previous Round: Go to the previous round. -Turn Display: Display the current round and turn. -Roll Initiative: Roll initiative for the combatants. |
| Initiative Mode | (Roll Initiative only) Set what combatants to roll initiative for:-All: All combatants. -Current Combatant: The current combatant only. -Player Characters: Player characters only. -Non-Player Characters: Non-player characters only. |
| Display | -Icon: (All except for Turn Display) Display a relevant icon.-Round: ( Turn Display only) Display the current round.-Turn: ( Turn Display only) Display the current turn. |