Skip to content

Please add action "custom variable: set or create with expression value if not exists" #3633

@LikeThisReview

Description

@LikeThisReview

Is this a feature relevant to companion itself, and not a specific module?

  • I believe this to be a feature for companion, and is not specific to a module

Is there an existing issue for this?

  • I have searched for similiar existing issues

Describe the feature

Please add action "internal: custom variable: set or create with expression value if not exists" with following fields:
Description: test boolean 1 0
Custom Variable: free text for example test_boolean (the name of the new variable)
Expression: false
Select: Persist value / Write start up value.

This action will then create a boolean custom variable {} false, instead of T false. It will combine the Create (and Set Custom Variable with Expression) and Write actions. It also adds the description as one can in the Custom Variables view. Other examples: enter 5 or null in expression field.

Usecases

Action "custom variable: set or create raw value" is great for sharing pages with related variables.
Create a page and a button which create the variables and the only thing another person will need to do is import the pages and hit the button. It is also great in Triggers! A selective import of triggers is possible in Companion v4.0.3 with "Import (Replace / Append to existing)"; selective import of custom variables is not possible.

The actions can also be used to reset your setup. For example in your pages for atem switcher you make all kind of changes and then want to go back to (an) initial state (without restarting Companion), and to keep it in sync with atem switcher after restart (restore saved startup state or restore switcher)

Metadata

Metadata

Assignees

No one assigned

    Labels

    EnhancementNew feature or requestarea/internalRelated to an internal action or function of Companion.

    Type

    No type

    Projects

    Status

    No status

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions