Difference between revisions of "AGI Command Reference"

From AGI Wiki
Jump to navigationJump to search
Line 10: Line 10:
 
==Commands by Category:==
 
==Commands by Category:==
  
*[[System Commands]]
+
*'''[[:Category:Test Commands|Test Commands]]'''
 +
:Test commands return a boolean result and are used in [[if]] statements.
 +
*'''[[:Category:Mathematical Commands|Mathematical Commands]]
 +
:Mathematical commands are used for working with [[variables]] and [[number|numbers]] in AGI.
 +
*'''[[:Category:Flag Commands|Flag Commands]]'''
 +
:These commands are used to test the status of [[flags]], and to set, reset, and toggle flag values.
 +
*'''[[:Category:Flow Control Commands|Flow Control Commands]]'''
 +
:This group of commands deals with control of [[logic]] scripts and [[room]] changes.
 +
*'''[[:Category:Picture Commands|Picture Commands]]'''
 +
:Commands for manipulating [[picture]] resources.
 +
*'''[[:Category:Screen Object Control Commands|Screen Object Control Commands]]'''
 +
:These commands are used to set up and manipulate [[screen objects]].
 +
*'''[[:Category:Screen Object Motion Control Commands|Screen Object Motion Control Commands]]'''
 +
:Commands to control the motion of [[screen objects]].
 +
*'''[[:Category:Inventory Item Commands|Inventory Item Commands]]'''
 +
:This group has the commands used to control and manage the [[inventory items]] listed in the [[OBJECT]] file.
 +
*'''[[:Category:Sound Commands|Sound Commands]]'''
 +
:Commands for manipulating [[sound]] resources.
 +
*'''[[:Category:String Commands|String Commands]]'''
 +
:The few commands that can be used to manipulate [[strings]] are listed in this topic.
 +
*'''[[:Category:Display Commands|Display Commands]]'''
 +
:The display commands control printing and displaying text in AGI.
 +
*'''[[:Category:Player Input Commands|Player Input Commands]]'''
 +
:These commands deal with collecting [[player input]] via the [[keyboard]], [[joystick]], and [[mouse]]. It also includes commands for managing [[menus]].
 +
*'''[[:Category:System Commands|System Commands]]'''
 +
:Commands for dealing with system activities such as [[saving/restoring/restarting]] and controlling input related activities.
 +
*'''[[:Category:Debugging Commands|Debugging Commands]]'''
 +
:Commands that allow AGI programmers to do limited [[debugging]] of games during development.

Revision as of 19:47, 22 March 2019

AGI Logic Command Reference

The AGI commands provide the "brains" of AGI games. Logic scripts contain the commands that AGI uses to perform game functions, control game play and manipulate other resources such as pictures and views. Logic source code is written in a scripting language that can be compiled into pseudo-code, which is what AGI reads during game play.

Although it may seem that AGI is not an overly complex language, it does take a full understanding of its inner workings to be able to successfully create a full featured AGI game. Understanding how the main interpreter cycle works, as well as how the different resources are loaded and accessed is critical in being able to create workable AGI games.

Detailed information is provided in this section on each command available in AGI, as well as a description of syntax rules. There are also some introductory topics dealing with common AGI programming tasks, such as working with objects, the text mode, debugging, etc.

Commands by Name

Commands by Category:

Test commands return a boolean result and are used in if statements.
Mathematical commands are used for working with variables and numbers in AGI.
These commands are used to test the status of flags, and to set, reset, and toggle flag values.
This group of commands deals with control of logic scripts and room changes.
Commands for manipulating picture resources.
These commands are used to set up and manipulate screen objects.
Commands to control the motion of screen objects.
This group has the commands used to control and manage the inventory items listed in the OBJECT file.
Commands for manipulating sound resources.
The few commands that can be used to manipulate strings are listed in this topic.
The display commands control printing and displaying text in AGI.
These commands deal with collecting player input via the keyboard, joystick, and mouse. It also includes commands for managing menus.
Commands for dealing with system activities such as saving/restoring/restarting and controlling input related activities.
Commands that allow AGI programmers to do limited debugging of games during development.