Flow Scripting Documentation

run()

"run"will execute when the user clicks the tile or executes the script via the Otto search bar. Returning a duration (in ms) will delay the closure of the flow wheel by the specified duration. Ret...

exit()

"exit" will execute before the script is reloaded or deleted. For the good of everyone, please be diligent and clear your loops, intervals and timeouts here. exit(() => { // your exit code he...

info()

"info" will automatically execute every 500ms when the tile is visible and updates the content shown in the center circle when the tile is hovered. MDI icons are not supported here. info(() => ...

state()

"state" will automatically execute every 500ms when the tile is visible and updates the content of the script's tile. MDI icons are supported here (e.g. mdi:airplane). A full list of icons is avail...

style()

"style" will automatically execute every 500ms when the tile is visible and updates the style of the tile. style(() => { return 'armed'; // Can be 'armed', 'active', 'error' or null });  

settings_define()

"settings_define" Allows the user to customize settings for your scripts. Right now, only checkbox and text are allowed. If you change a setting internally, you can send settings_define(...) again ...

loop_[frequency]()

"loop_..." will automatically execute at the frequency specified. loop_1hz loop_15hz loop_30hz loop_60hz loop_frame loop_frame(() => { // Your code every frame here }); loop_30hz(() => {...

search()

"search" will execute when a search query is performed on the script via the Otto search bar. let result_1 = null; // Keep track of those if you want to re-use them on query updates let result_2 =...

scroll()

"scroll" will execute when the user scrolls the tile with the scroll wheel. scroll((event) => { example_event = { from: 'wheel', // where was the command sent from. Can be 'wheel' '...

html_created()

"html_created" will execute when the script has HTML and that the element was created. let html_element = null; html_created((el) => { html_element = el; });  el: The HTML element that was cr...

script_message_rcv()

"script_message_rcv" will execute when receiving a message from another script using the this.$api.command.script_message_send API function. script_message_rcv((caller_reference_name, message, rep...

twitch_message()

If the Twitch integration is enabled by the user in the Flow settings, chat messages will come through "twitch_message". If the user specified a command via the script settings, this will only exec...

twitch_connection()

If the Twitch integration is enabled by the user in the Flow settings, the connection state of the Twitch integration will come through here. twitch_connection((state) => { if(state) { ...