What are variables?

Variables store a value generated by its own template that can be be called in a Template in the same way that tags are. They allow you to organize your script in a more pleasing manner.

How do I declare a variable?

Just add "Variable" followed by the name you wish to give it (in the following example it's "num") and finally "{}" to the script.

Variable num {}

The following shows each property set to its default value.

Variable num { // The default variable increments itself by one after each time its called and starts at 0.
   template = <[num] + 1>;
   startvalue = 0;
   refresh = 2 (after);

What properties are there?

  -template (Template)
  -startvalue (Start Value)
  -refresh (Auto Refresh)

template (Template)

The template property specifies a template to associate with the variable's value.


template = string;

startvalue (Start Value)

The startvalue property specifies the variables starting value.


startvalue = integer;
startvalue = decimal;
startvalue = string;

refresh (Auto Refresh)

The refresh property specifies whether and how the variable should auto refresh its value when called.


refresh = integer {0, 1, 2};
refresh = string {no, before, after};

A refresh value of "0" or "no" specifies there to be no refresh automation. When refresh has a value of "1" or "before", the variable will refresh itself to its template before it is called. Finally when refresh is set to "2" or "after", the variable will refresh itself after it is called.

What methods are there?

  -reset (Reset)
  -refresh (Refresh)
  -set (Set)

reset (Reset)

The reset method resets the value of the variable to its start value.

Use: (Using the Variable "num".)


refresh (Refresh)

The refresh method sets the value of the variable to its template.

Use: (Using the Variable "num".)


set (Set)

The set method sets the value of the variable to the value of the passed parameter.

Use: (Using the Variable "num".)