QS0 Expr Variables

home/reference v0.x/{expressions}/Variables

Variables are instantiated on load-time. All references from {expressions} to variables will report an error, if the variable isn't instantiated.

Variables can be instantiated in two ways:

<var>

With a <var> node at the beginning a parent-node. The <var> node's {expression} is instantiated AND evaluated at the load-time of the script. If the <var> node is a child of a <que> node, it will be evaluated once more when the <que> starts playing and upon each subsequent loop.

The variable will be in the scope of the node it is located. It is possible to have multiple variables of the same name, but each has to be located in a different scope:

<script>
<var name="scriptScopeVar">99</var>
<que name="que_1" loop="no">
    <var name="scriptScopeVar">{scriptScopeVar / 3}</var>
        <print>scriptScopeVar is {scriptScopeVar}</print>

On loading the script, the {expression} of the <var> node inside the <que> can access the value of the {scriptScopeVar} inside the <script> scope. But on execution of the script, the {expression} inside the <print> node will only be able to access the {scriptScopeVar} inside the scope of the <que>, while the {scriptScopeVar} of the <script> scope will be hidden.

Instantiate Variables with : or :: prefix to the variable name

• ':' prefix instantiates the variable in the local scope if it doesn't exist in ANY scope yet.
• '::' prefix instantiates the variable in the local scope if it doesn't exist in the local scope yet.

In other words: ':' only creates a variable if doesn't exist yet, '::' creates one no matter.

But in difference to the <var> it will be evaluated only when the node is executed.

<while name="Loop" init="{:var = 0}" condition="{var lt 100}" next="{var = (var + 1)}">
    <print>inside while: {var}</print>
</while>

In case of the <while> node, the attribute 'init' is evaluated first, so the prefix needs to be set there. Once the 'init'-{expression} is evaluated, the variable 'var' is instantiated and can be accessed by the other attributes and the child nodes.

---

An {expression} that references an undeclared variable will throw an error:

i.e.: Error: : Variable 'globalVar' not declared | {globalVar = 1} at line(9)

If variables of the same name exist in multiple scopes, the {expressions} will take the first one it finds with the following preference: ocal-scope -> ... -> que-scope -> script-scope.

The variables inside the script-scope are accessible by all {expressions} inside all ques (i.e. $HOUR, $MIN, $SEC, $MILLI).

All variables set by the user through a message-list like

var 'name' 'value'

need to be declared with <var> node inside the <script> node, otherwise they will be ignored.

if a message list with more than three tokens is received, like

var 'name' 'value1' 34 8.98983

it will be turned into an Array with 'name' as the variable-name and the subsequent list as the elements inside the array.

script-scope variables keep their values even if the script is reloaded or a new script is loaded. To clear those values you can use the message.

reset

which also stops all running ques and reloads the same script.

All variables inside the que-scopes and sub-scopes will be lost once a new script is reloaded.

If your newly loaded script needs to access the value a script-scope variable which has been changed through user interaction via a 'var' message in a previous script, then you can initialize it at the beginning of the script the following way:

<var name="gvar">{if(:gvar == NULL, 0, gvar)}</var>

':gvar' will cause the {expressions} to instantiate a variable if it doesn't exist. The 'if'-condition will then set gvar to 0 since the newly instatiated variable is NULL. If the variable existed in the last script, its value will be taken to set the 'gvar' again.

A special case is the sub-node <anim>:

Variables generated inside the sub-node <anim> belong to either its own scope or the scope of its parent <que> node. Assuming an example like the following:

<var name="g1.a1.t1">0</var>
<que>
   <anim name="a1">
      <var name="g1.a1.t1">0</var>
      <track name="t1">0 1.</track>
      <track name="t2">0 1.</track>
      <send>address command {t1} {t2}</send>
      <expr>{g1.a1.t1 = t1}</expr>
   </anim>
   <while condition="true">
      <send>adress command {a1.t1} {a1.t2}</send>
      <send>adress command {g1.a1.t1}</send>
   </while>
</que>

<track> generates for each track two variables:

• t1 and t2 for the sub-node <anim> scope. They can be accessed by the <send> and <var> cmnd inside the <anim> cmnd.
• a1.t1 and a1.t2 for the <que> node. They can be accessed by the <send> cmnd outside the <anim> node

In order to make the values accessible for all the script, you can use the <var> cmnd. Please note though: if you want to make sure that all the current iterated values inside the <anim> cmnd are passed on to a variable inside the <script>-scope, the <expr> cmnd needs to be inside the <anim> cmnd.

Note

You can use the <debugger> node to see the current content of all the nodes. Important: if you place the <debugger> inside an animation node like <anim> or <while> you will see different domains than if you place it outside of it.