Scene Action

The Scene action give control over Foundry's scenes.

You can use it to display scenes on the Stream Deck, switch scenes in Foundry, activate scenes in Foundry, or set the scene darkness.

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.
Function	The function of the button: -Scene Control: Open or close scenes. -Scene Offsets: Configure scene offsets. -Darkness Control: Control the current scene's darkness level. -Move Canvas: Move the canvas or zoom in or out

Scene Control

With this function you can open or activate scenes.

Option	Description
Scene Selection	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 by Name/ID: Select a scene by its name or ID. -Active Scene: Selects the currently active scene. -All other options: List of scenes to select from.
Scene Nr	(Visible Scenes and Any Scene only) Number of the scene to select, see below.
Scene Name/ID	(Select by Name/ID only) Name or ID of the scene to select.
On Press/ On Hold	What to do when the button is pressed/held down: -View: View (open) the selected scene. -Activate: Activate the selected scene. -View/Activate if Viewed: View (open) the selected scene if it's not currently open. If it is already open, activate the scene. -Preload Scene: Preload the scene.
Display	-Name: Display the scene or navigation name of the scene on the Stream Deck. -Icon: Display the scene's background on the Stream Deck.
Colors	-Open Color: A border is drawn on the Stream Deck of this color if the scene is currently open. -Active Color: A border is drawn on the Stream Deck of this color if the scene is currently active. -Off Color: A border is drawn on the Stream Deck of this color if the scene is currently not open or active. -Background: Background color of the button.

Scene Nr

Selects a scene using a number.
This is mostly useful if you want to keep things flexible. For example, if you have multiple buttons set to Visible Scenes with scene nr's from 1 to 10, you would always have control over the first 10 visible scenes, even if you change which scenes are visible.

In case of Visible Scenes, 1 is the left-most scene that's visible, 1 is the scene to the right of that, etc.
In case of Any Scene, the number is based on how Foundry has organised the scenes.

Scene Offsets

Scene offsets can be used in combination with Scene Nr to give an offset to the scene nr.
For example, if the scene offset is set to 10, a button with Scene Nr set to 1 will then have scene 11 selected, a button with Scene Nr set to 5 will have scene 15 selected.

This can be used to browse through scenes.
For example, say you have 5 buttons with Scene Nr set from 1 to 5, and a button with Offset Mode Increase/Decrease and Offset of 1. If you then press the offset button, the offset will increase to 1, so now scenes 2 through 6 are selected.

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.

Darkness Control

Allows you to set the darkness of the current scene.

Option	Description
Mode	Sets how to control the darkness: -Set to Value: Sets the darkness to the value set in Value. -Increase/Decrease: Increases the darkness by the value set in Value. -Transition to Day: Transitions to day. -Transition to Night: Transition to night.
Value	(Set to Value and Increase/Decrease only) The value to set the darkness to (in case of Set to Value), or the value to increment the darkness with (in case of Increase/Decrease).
Animation Time	Time in milliseconds that the animation takes when changing the scene darkness.
Display	-Value: Display the current scene darkness on the Stream Deck. -Icon: Display an icon on the Stream Deck.
Colors	-On Color: (Not for Increase/Decrease) A border is drawn on the Stream Deck of this color if the current scene darkness is equal to the offset configured in Value. -Off Color: (Not for Increase/Decrease) A border is drawn on the Stream Deck of this color if the current scene darkness is not equal to the offset configured in Value. -Background: Background color of the button.

Move Canvas

This function allows you to move the canvas or zoom in or out.

Option	Description
Direction	Sets what to do on a button press: -Center: Centers the canvas. -Up/Down/Left/Right etc: Move the canvas in this direction by the value set in Distance (in grid spaces). -Zoom In/Zoom Out: Zoom in or out on the canvas by the value set in Distance.
Distance	(Not shown for Center) The distance to move the canvas or value to zoom in/out by.
Display	-Icon: Display an icon on the Stream Deck.
Colors	-Background: Background color of the button.