Difference between revisions of "AGI Command Reference"

From AGI Wiki
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Tutorials and Guides|Tutorials and Guides Table of Contents]]<br />
+
<div align="center"><span style="font-size: 22pt">AGI Logic Command Reference</span><br /></div>
 +
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 [[picture|pictures]] and [[view|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.
  
<div align="center"><span style="font-size: 22pt">AGI Logic Command Reference</span><br />
+
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.
''By [[Chris Cromer]]''</div>
 
  
&nbsp;
+
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.<br/>
  
<blockquote>
+
==[[:Category:Commands|Commands by Name]]==
'''Table of Contents'''
+
A list of all AGI commands alphabetically by name.
  
# [[AGI Command Reference - Arithmetic Commands|Arithmetic Commands]]
+
==Commands by Category:==
# [[AGI Command Reference - Commands to Load and unLoad Resources|Commands to Load and unLoad Resources]]
 
# [[AGI Command Reference - Program Control Commands|Program Control Commands]]
 
# [[AGI Command Reference - Object Control Commands|Object Control Commands]]
 
# [[AGI Command Reference - Object Description Commands|Object Description Commands]]
 
# [[AGI Command Reference - Object Motion Control Commands|Object Motion Control Commands]]
 
# [[AGI Command Reference - Inventory Item Management Commands|Inventory Item Management Commands]]
 
# [[AGI Command Reference - Picture Resource Management Commands|Picture Resource Management Commands]]
 
# [[AGI Command Reference - Sound Resource Management Commands|Sound Resource Management Commands]]
 
# [[AGI Command Reference - Text Management Commands|Text Management Commands]]
 
# [[AGI Command Reference - String Management Commands|String Management Commands]]
 
# [[AGI Command Reference - Initialization Commands|Initialization Commands]]
 
# [[AGI Command Reference - Menu Management Commands|Menu Management Commands]]
 
# [[AGI Command Reference - Test Commands|Test Commands]]
 
# [[AGI Command Reference - Other Commands|Other Commands]]
 
# [[AGI Command Reference - Unknown Commands|Unknown Commands]]
 
</blockquote>
 
&nbsp;
 
  
A large Reference of all the different available AGI logic commands. Thanks to the Sarien team and to [[Nick Sonneveld]] for some info on the unknown 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.
<div align="center">
+
*'''[[:Category:Flag Commands|Flag Commands]]'''
Page:  
+
:These commands are used to test the status of [[flags]], and to set, reset, and toggle flag values.
[[AGI Command Reference - Arithmetic Commands|1]] |
+
*'''[[:Category:Flow Control Commands|Flow Control Commands]]'''
[[AGI Command Reference - Commands to Load and unLoad Resources|2]] |
+
:This group of commands deals with control of [[logic]] scripts and [[room]] changes.
[[AGI Command Reference - Program Control Commands|3]] |
+
*'''[[:Category:Picture Commands|Picture Commands]]'''
[[AGI Command Reference - Object Control Commands|4]] |
+
:Commands for manipulating [[picture]] resources.
[[AGI Command Reference - Object Description Commands|5]] |
+
*'''[[:Category:Screen Object Control Commands|Screen Object Control Commands]]'''
[[AGI Command Reference - Object Motion Control Commands|6]] |
+
:These commands are used to set up and manipulate [[screen objects]].
[[AGI Command Reference - Inventory Item Management Commands|7]] |
+
*'''[[:Category:Screen Object Motion Control Commands|Screen Object Motion Control Commands]]'''
[[AGI Command Reference - Picture Resource Management Commands|8]] |
+
:Commands to control the motion of [[screen objects]].
[[AGI Command Reference - Sound Resource Management Commands|9]] |
+
*'''[[:Category:Inventory Item Commands|Inventory Item Commands]]'''
[[AGI Command Reference - Text Management Commands|10]] |
+
:This group has the commands used to control and manage the [[inventory items]] listed in the [[OBJECT]] file.
[[AGI Command Reference - String Management Commands|11]] |
+
*'''[[:Category:Sound Commands|Sound Commands]]'''
[[AGI Command Reference - Initialization Commands|12]] |
+
:Commands for manipulating [[sound]] resources.
[[AGI Command Reference - Menu Management Commands|13]] |
+
*'''[[:Category:String Commands|String Commands]]'''
[[AGI Command Reference - Test Commands|14]] |
+
:The few commands that can be used to manipulate [[strings]] are listed in this topic.
[[AGI Command Reference - Other Commands|15]] |
+
*'''[[:Category:Display Commands|Display Commands]]'''
[[AGI Command Reference - Unknown Commands|16]]
+
:The display commands control printing and displaying text in AGI.
</div>
+
*'''[[: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]].
&nbsp;
+
*'''[[:Category:System Commands|System Commands]]'''
 
+
:Commands for dealing with system activities such as [[saving/restoring/restarting]] and controlling input related activities.
[[Tutorials and Guides|Tutorials and Guides Table of Contents]]
+
*'''[[:Category:Debugging Commands|Debugging Commands]]'''
 
+
:Commands that allow AGI programmers to do limited [[debugging]] of games during development.
<span style="float: left"><span class="Inactive">&lt; Previous: </span></span><span style="float: right">[[AGI Command Reference - Arithmetic Commands|Next: Arithmetic Commands &gt;]]</span>
 
 
 
&nbsp;
 
 
 
[[Category:Logic]]
 
[[Category:Commands]]
 
[[Category:References]]
 
[[Category:Tutorials]]
 

Latest revision as of 19:48, 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

A list of all AGI commands alphabetically 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.