Unset specified variables. The variables have been set either using the set command or as a byproduct of some other statements or methods (like record)

unset

string | string[]Required

The name of the variable to unset (as a string) or an array of variable names to unset.

Variable

Any variable can be unset by this method.

Examples

Unset a single variable

YAMLJSON

version: 1.0.0
sections:
  main:
    - set:
        num_var: 1
    - play:
        url: 'say: The value of num_var is: ${num_var}.'
    - unset: num_var
    - play:
        url: 'say: The value of num_var is ${num_var}.'

Unset multiple variables

YAMLJSON

version: 1.0.0
sections:
  main:
    - set:
        systems:
          hr:
            - tracy
            - luke
          engineering:
            john: absent
        name: john
    - play:
        url: 'say: ${systems.hr}'
    - unset:
        - systems
        - name
    # this play statement emits an error because `systems` is undefined
    # at this point so there's nothing for `play` to say.
    - play:
        url: 'say: ${systems}'

See Also

• Variables and Expressions: Complete reference for SWML variables, scopes, and syntax
• set: Set variables in the script