Function script_load

scripting/examples.py:114–182

(settings)

def script_load(settings):
    # Register an example action
    advss_register_action("My simple Python action", my_python_action)

    # Register an example action with settings
    advss_register_action(
        "My Python action with settings",
        my_python_settings_action,
        get_action_properties,
        get_action_defaults(),
    )

    # This example action demonstrates how to interact with variables
    advss_register_action("My variable Python action", variable_python_action)

    # Register an example condition
    advss_register_condition(
        "My Python condition",
        my_python_condition,
        get_condition_properties,
        get_condition_defaults(),
    )

    # Register an example condition which registers and sets macro properties
    advss_register_condition(
        "My Python condition (Macro properties)",
        my_temp_var_python_condition,
        macro_properties=[
            MacroProperty(
                "random_int",
                "Random number",
                "A random number generated in the range from 0 to 100",
            ),
            MacroProperty("some_other_value", "Another value", ""),
        ],
    )

    # Other signals and procedures, which might be useful
    def plugin_stop_handler(data):
        obs.script_log(obs.LOG_INFO, "Hello from stop handler!")
        get_running_status()

    def plugin_start_handler(data):
        obs.script_log(obs.LOG_INFO, "Hello from start handler!")
        get_running_status()

    def get_running_status():
        proc_handler = obs.obs_get_proc_handler()
        data = obs.calldata_create()
        obs.proc_handler_call(proc_handler, "advss_plugin_running", data)
        success = obs.calldata_bool(data, "is_running")
        obs.script_log(
            obs.LOG_INFO, f"The advanced scene switcher is currently running: {success}"
        )
        obs.calldata_destroy(data)

    def interval_reset_handler(data):
        obs.script_log(obs.LOG_INFO, "Hello from reset handler!")