B: The Variables and Commands

Each DLL can have a set of variables and a set of script commands it recognizes. In this section, all the available variables and commands will be sorted by the DLL they come from.

The Variables

Variables can be used in the command lines instead of values, or you can assign values to the variables.

ex:

echo: $TAG_MAX

report "256"

and the lines:

$TAG_NB = 256

$TAG_NB = $TAG_MAX

tag: number 256

tag: number $TAG_MAX

are all equivalent. They will all set the number of accessible TAGs to 256.

Variables start with the character "$".

Variables can be of different types, they can have one value, or multiple (array). The values can be integers, floating point or character strings. In the following lists, we will use the following abbreviations for the variable types:

	I₈	Signed character (8 bits)
	I₁₆	Signed short (16 bits)
	I₃₂	Signed integer (32 bits)
	I₆₄	Signed long integer (64 bits)
	U₈	Unsigned character (8 bits)
	U₁₆	Unsigned short (16 bits)
	U₃₂	Unsigned integer (32 bits)
	U₆₄	Unsigned long integer (64 bits)
	F₃₂	Floating point value 32 bits
	F₆₄	Floating point value 64 bits
	S	Character String.
	W	Wide Character String.
	V	Vector. A vector has 3 F₃₂ components: x y z
	C	Color. A color is a 32 bits unsigned integer where each component (RGBα) uses 8 bits.
	A	Array. An array is composed of 1 or more values.
	R	Read Only. A Read only variable cannot be changed through the command line.
	P	Pointer. A pointer is an address to an element in the program. Pointers cannot be used or modified through the command lines.
	U	Unlisted. Unlisted variable do not appear in the list of system variables.

Note:

"P" (pointers) and "U" (unlisted) variables are listed here mainly for completion's sake. Though they cannot be used in commands, they can be used in user modules.

For each variable, we give:

• The name of the variable in green.

• The abbreviation for the type of the variable (between parenthesis).

• A description of the variable.

The Commands

Please remember that only the first 3 characters of a command and of most of its arguments are used to identify it. To make this clearer, only the necessary first 3 characters of the commands in the following command lines will be in bold.

so the command:

interface: size small

is equivalent to

int: siz smal

The commands and most arguments (except those in italics) are not case sensitive, so

Int: Size SMALL

is equivalent to

int: size small

W

Wide Character String.