AGIWiki/Logic syntax

From ScummVM :: Wiki
< AGIWiki
Revision as of 15:12, 25 October 2018 by Criezy (talk | contribs) (Text replacement - "<source lang=" to "<syntaxhighlight lang=")
Jump to navigation Jump to search

This article describes the logic syntax for the C-like "official" AGI syntax described in the AGI Specs and supported by AGI Studio and WinAGI.

Note: The WinAGI development environment supports an alternate syntax, that is based on Microsoft's Visual Basic language, rather than the C language. At this time, the C-based syntax described in this article is the most widely-supported AGI logic syntax.

Action Commands

Normal action commands are specified by the command name followed by parentheses which contain the arguments, separated by commas. A semicolon is placed after the parentheses. The parentheses are required even if there are no arguments. The arguments given must have the correct prefix for that type of argument as explained later in this document (this is to make sure the programmer does not use a variable, for example, when they think they are using a flag).

<syntaxhighlight lang="cpp"> assign.v(v50,0);

program.control(); </source>

Multiple commands may be placed on the one line:

<syntaxhighlight lang="cpp"> reset(f6); reset(f7); </source>

Substitutions for the following action commands are available:

<syntaxhighlight lang="cpp"> increment(v30); v30++; decrement(v30); v30--; assignn(v30,4); v30 = 4; assignv(v30,v32); v30 = v32; addn(v30,4); v30 = v30 + 4; or v30 += 4; addv(v30,v32); v30 = v30 + v32; or v30 += v32; subn(v30,4); v30 = v30 - 4; or v30 -= 4; subv(v30,v32); v30 = v30 - v32; or v30 -= v32; mul.n(v30,4); v30 = v30 * 4; or v30 *= 4; mul.v(v30,v32); v30 = v30 * v32; or v30 *= v32; div.n(v30,4); v30 = v30 / 4; or v30 /= 4; div.v(v30,v32); v30 = v30 / v32; or v30 /= v32;

lindirectn(v30,4); *v30 = 4; lindirectv(v30,v32); *v30 = v32; rindirect(v30,v32); v30 = *v32; </source>

If structures and test commands

An if structure looks like this:

<syntaxhighlight lang="cpp"> if (test commands) {

 action commands

} </source>

or like this

<syntaxhighlight lang="cpp"> if (test commands) {

 action commands

} else {

 more action commands

} </source>

Carriage returns are not necessary:

<syntaxhighlight lang="cpp"> if (test commands) { action Commands } else { more action commands } </source>

Test commands are coded like action commands except there is no semicolon. They are separated by && or || for AND and OR, respectively:

<syntaxhighlight lang="cpp"> if (isset(f5) &&

   greatern(v5,6)) { ......


Again, carriage returns are not necessary within the if statement:

<syntaxhighlight lang="cpp"> if (lessn(v5,6) && (greatern(v5,2)) { .......

if (isset(f90) && equalv(v32,v34) &&

   greatern(v34,20)) { .......


A ! placed in front of a command signifies a NOT.

<syntaxhighlight lang="cpp"> if (!isset(f7)) {



Boolean expressions are not necessarily simplified so they must follow the rules set down by the file format. If test commands are to be ORred together, they must be placed in brackets.

<syntaxhighlight lang="cpp"> if ((isset(f1) || isset(f2)) {


if (isset(f1) && (isset(f2) || isset(f3))) {


if (isset(1) || (isset(2) && isset(3))) { is NOT legal </source>

Depending on the compiler, simplification of boolean expressions may be supported, so the above may not apply in all cases (although if these are rules are followed then the logic will work with all compilers).

Substitutions for the following test commands are available:

<syntaxhighlight lang="cpp"> equaln(v30,4) v30 == 4 equalv(v30,v32) v30 == v32 greatern(v30,4) v30 4 greaterv(v30,v32) v30 v32 lessn(v30,4) v30 4 lessv(v30,v32) v30 v32 !equaln(v30,4) v30 != 4 !equalv(v30,v32) v30 != v32 !greatern(v30,4) v30 = 4 !greaterv(v30,v32) v30 = v32 !lessn(v30,4) v30 = 4 !lessv(v30,v32) v30 = v32 </source>

Also, flags can be tested for by just using the name of the flag:

<syntaxhighlight lang="cpp"> if (f6) { .....

if (v7 > 0 && !f6) { ..... </source>

which is equivalent to:

<syntaxhighlight lang="cpp"> if (isset(f6)) { .....

if (v7 > 0 && !isset(f6)) { ..... </source>

Argument types

There are 9 different types of arguments that commands use:

Type Prefix
Number (no prefix)









Inventory item








The said test command uses its own special arguments which will be described later.

Each of these types of arguments is given by the prefix and then a number from 0-255, e.g. v5, f6, m27, o2.

The word type represents words that the player has typed in (as opposed to words that are stored in the WORDS.TOK file). Strings are the temporary string variables stored in memory, not to be confused with messages (that are stored in the logic resources). Controllers are menu items and keys.

Compilers can enforce type checking, so that the programmer must use the correct prefix for an argument so that they know they are using the right type. Decoders should display arguments with the right type.

<syntaxhighlight lang="cpp"> move.obj(o4, 80, 120, 2, f66);

if (, 30, 60, 120, 40)) { ..... </source>

For a complete list of the commands and their argument types, see Logic commands by name.

Messages and inventory items may be given in either numerical or text format:

<syntaxhighlight lang="cpp"> print("He's not here.");


if (has("Jetpack")) { .....

if (has(i9)) { .....

</source> Messages can also be split over multiple lines:

<syntaxhighlight lang="cpp"> print("This message is split "

     "over multiple lines.");


Quote marks must be used around messages and inventory item names. This is important because some messages or inventory item names may contain parentheses or commas, which could confuse the compiler. This is also the case for the said command which will be described shortly.

<syntaxhighlight lang="cpp"> if (has("Buckazoid(s)")) { ..... // no ambiguity here about where

                                  // the argument ends


If quote marks are part of the message or inventory object, a \ should be placed in front of these. To use a \, \\ should be used. \n can also be used for a new line.

The said test command uses different parameters to all the other commands. Where as the others use 8 bit arguments (0-255), said takes 16 bit arguments (0-65535). Also, the number of arguments in a said command can vary. The numbers given in the arguments are the word group numbers from the WORDS.TOK file.

<syntaxhighlight lang="cpp"> if (said(4, 80)) { ..... </source>

Words can also be given in place of the numbers:

<syntaxhighlight lang="cpp"> if (said("look")) { .....

if (said("open","door")) { ..... </source>

Quote marks must also be used around the words.

Labels and the goto command

Labels are given like this:

<syntaxhighlight lang="cpp"> Label1: </source>

The label name can contain letters, numbers, and the characters '_' and '.'. No spaces are allowed.

The Goto command takes on parameter, the name of a label:

<syntaxhighlight lang="cpp"> goto(Label1); </source>


There are three ways that comments can be used.

<syntaxhighlight lang="cpp"> // - rest of line is ignored

[ - rest of line is ignored

/* Text between these are ignored */ </source>

The /*...*/ can be nested:

<syntaxhighlight lang="cpp"> /* comment start

 print("Hello");    // won't be run
 /*                 // a new comment start (will be ignored!)
   v32 = 15;        // won't be run
 */                 // uncomments the most inner comment
 print("Hey!");     // won't be run, still inside comments
  • / // uncomments


Note: the fact that these comments can be nested is very different from almost every other language that uses these types of comments, including C, C , and Java.


See Defines.

Including files

See Includes.

More on messages

In some cases you may want to assign a specific number to a message so you can refer to it in other places. This is done by using the #message command, followed by the number of the message then the message itself:

<syntaxhighlight lang="cpp">

  1. message 4 "You can't do that now."


Then you can give the message number as the parameter in commands:

<syntaxhighlight lang="cpp"> print(m4); </source>

Or embed the message in commands as normal and the number you assigned to it before will be used:

<syntaxhighlight lang="cpp"> print("You can't do that now."); </source>

#message can be used anywhere in the file, so you do not have to set the message before you use it.

For more details, see Message.

The return command

The return command is just a normal action command (command number 0), with no arguments. This must be the last command in every logic resource.

See also