From dc0b8cfa2f973d3232ebc9c2d887bd23fd59d4af Mon Sep 17 00:00:00 2001 From: WarmUpTill Date: Sat, 22 Mar 2025 20:25:06 +0100 Subject: [PATCH] Updated Scripting (markdown) --- Scripting.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/Scripting.md b/Scripting.md index ec37403..9addc9f 100644 --- a/Scripting.md +++ b/Scripting.md @@ -430,6 +430,7 @@ Even if you should choose to reload the script at a later point in time the sett # Detailed API description +## Procedures The advanced scene switcher offers the following [procedure handlers](https://docs.obsproject.com/reference-libobs-callback#procedure-handlers): * `bool advss_register_script_action(in string name, in ptr default_settings, out string properties_signal_name, out string trigger_signal_name)` @@ -441,6 +442,15 @@ The advanced scene switcher offers the following [procedure handlers](https://do * `bool advss_register_temp_var(in string temp_var_id, in string temp_var_name, in string temp_var_help, in int instance_id)` * `bool advss_deregister_temp_vars(in int instance_id)` * `bool advss_set_temp_var_value(in string temp_var_id, in string value, in int instance_id)` +* `bool advss_plugin_running()` + +## Signals + +The advanced scene switcher offers the following [signals](https://docs.obsproject.com/reference-libobs-callback#signals): + +* `void advss_plugin_stopped()` +* `void advss_plugin_started()` +* `void advss_interval_reset()` ## advss_register_script_action @@ -875,3 +885,26 @@ See `advss_register_script_action` for more details. The return value can be queried via `success` from the calldata object associated with this procedure. Returns `true`, if the operation was successful, and `false` otherwise. + +## advss_plugin_running + +Can be used to query if the plugin is currently running or not. + +### Return value + +The return value can be queried via `is_running` from the calldata object associated with this procedure. +Returns `true`, if the advanced scene switcher plugin is currently started, and `false` otherwise. + +## advss_plugin_stopped + +This signal is emitted when the advanced scene switcher plugin is stopped. + +## advss_plugin_started + +This signal is emitted when the advanced scene switcher plugin is started. + +## advss_interval_reset + +This signal is emitted when the advanced scene switcher plugin has processed all macro conditions. +It can be used if you need to perform tasks before the next round of conditions checks starts. +The frequency at which this signal is emitted depends mostly on the "Check conditions every ... ms" value configured on the General tab.