Difference between revisions of "Controller"
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | ''This article refers controller | + | ''This article refers the controller command. For information about Controllers as part of an AGI game, see [[Controllers]].'' |
| − | The '''controller''' command returns TRUE if a menu item or key assigned to the controller has been selected or pressed during the current cycle. | + | The '''controller''' test command returns TRUE if a [[menu]] item or [[key]] assigned to the [[controller]] has been selected or pressed during the current [[interpreter cycle]]. |
| − | == | + | == Syntax == |
| − | + | controller([[controllers|ctl]] cA) | |
| − | == | + | == Remarks == |
| − | + | Test commands are only valid in an <code>if</code> statement. | |
| − | + | This test command can be combined with the <code>NOT</code> operator to test for a controller NOT being selected. | |
| − | + | AGI checks the [[controllers#evaltable|controller evaluation table]] entry for '''cA''' and returns TRUE if the controller has been activated. If more than one menu or keyboard entry is assigned to the controller, it does not matter which one is selected/pressed. Any of them will cause the '''controller''' command to return TRUE. | |
| − | + | AGI clears all controllers at the beginning of each [[interpreter cycle]]. | |
| − | == | + | == Possible Errors == |
| + | |||
| + | AGI does not validate the argument '''cA''' to be sure it points to a valid controller. If '''cA''' is invalid, when AGI accesses the [[controllers#evaltable|controller evaluation table]], it will overflow and read invalid memory, leading to unpredictable results. | ||
| + | |||
| + | == Example == | ||
<div class="CodeBlockHeader">Code:</div> | <div class="CodeBlockHeader">Code:</div> | ||
| − | |||
<syntaxhighlight lang="agi"> | <syntaxhighlight lang="agi"> | ||
| − | + | [ build a simple menu system | |
set.menu("Info"); | set.menu("Info"); | ||
set.menu.item("About ", c0); | set.menu.item("About ", c0); | ||
| Line 33: | Line 36: | ||
set.menu.item("-------------------", c20); | set.menu.item("-------------------", c20); | ||
set.menu.item("Quit <Alt Z>", c5); | set.menu.item("Quit <Alt Z>", c5); | ||
| − | + | [ disable the separators | |
disable.item(c20); | disable.item(c20); | ||
| − | + | [ submit menu to agi | |
submit.menu() | submit.menu() | ||
| − | + | [ create keyboard shortcuts | |
| − | set.key(0, 63, c2); | + | set.key(0, 63, c2); [ 'F5' |
| − | set.key(0, 65, c3); | + | set.key(0, 65, c3); [ 'F7' |
| − | set.key(0, 67, c4); | + | set.key(0, 67, c4); [ 'F9' |
| − | set.key(26, 0, c5); | + | set.key(26, 0, c5); [ 'Alt-Z' |
| − | + | [ test for menu or keyboard selections | |
| − | if (controller(c2) { | + | if(controller(c2) |
| − | + | { | |
| + | [ save game | ||
save.game(); | save.game(); | ||
| − | } | + | } |
| − | if (controller(c3) { | + | if(controller(c3) |
| − | + | { | |
| + | [ restore game | ||
restore.game() | restore.game() | ||
| − | } | + | } |
| − | </syntaxhighlight | + | </syntaxhighlight> |
== Technical Information == | == Technical Information == | ||
{| border="1" cellpadding="2" | {| border="1" cellpadding="2" | ||
| − | | style="background-color: #efefef" | '''Required | + | | style="background-color: #efefef" width="200" | '''Required Interpreter Version:''' |
| − | | Available in all AGI versions | + | | width="175" | Available in all AGI versions. |
|- | |- | ||
| − | | style="background-color: #efefef" | ''' | + | | style="background-color: #efefef" | '''Byte-Code Value:''' |
| 12 (0x0C hex) | | 12 (0x0C hex) | ||
|} | |} | ||
| − | == | + | == See Also == |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[ | + | [[Player Input Commands]]<br /> |
| − | [[Category: | + | [[Controllers]]<br /> |
| + | [[Category:Commands]]<br /> | ||
Latest revision as of 14:52, 21 April 2019
This article refers the controller command. For information about Controllers as part of an AGI game, see Controllers.
The controller test command returns TRUE if a menu item or key assigned to the controller has been selected or pressed during the current interpreter cycle.
Syntax
controller(ctl cA)
Remarks
Test commands are only valid in an if statement.
This test command can be combined with the NOT operator to test for a controller NOT being selected.
AGI checks the controller evaluation table entry for cA and returns TRUE if the controller has been activated. If more than one menu or keyboard entry is assigned to the controller, it does not matter which one is selected/pressed. Any of them will cause the controller command to return TRUE.
AGI clears all controllers at the beginning of each interpreter cycle.
Possible Errors
AGI does not validate the argument cA to be sure it points to a valid controller. If cA is invalid, when AGI accesses the controller evaluation table, it will overflow and read invalid memory, leading to unpredictable results.
Example
<syntaxhighlight lang="agi"> [ build a simple menu system set.menu("Info"); set.menu.item("About ", c0); set.menu.item("Help ", c1); set.menu("File"); set.menu.item("Save Game <F5>", c2); set.menu.item("Restore Game <F7>", c3); set.menu.item("-------------------", c20); set.menu.item("Restart Game <F9>", c4); set.menu.item("-------------------", c20); set.menu.item("Quit <Alt Z>", c5); [ disable the separators disable.item(c20);
[ submit menu to agi submit.menu()
[ create keyboard shortcuts set.key(0, 63, c2); [ 'F5' set.key(0, 65, c3); [ 'F7' set.key(0, 67, c4); [ 'F9' set.key(26, 0, c5); [ 'Alt-Z'
[ test for menu or keyboard selections if(controller(c2)
{
[ save game
save.game();
}
if(controller(c3)
{
[ restore game
restore.game()
}
</syntaxhighlight>
Technical Information
| Required Interpreter Version: | Available in all AGI versions. |
| Byte-Code Value: | 12 (0x0C hex) |
