Controller - Revision history

Andrew Korson: /* Example */

2019-04-21T19:52:28Z

Example

Andrew Korson: /* Example */

2019-04-14T16:53:29Z

Example

Andrew Korson at 00:31, 29 March 2019

2019-03-29T00:31:54Z

Andrew Korson at 00:31, 29 March 2019

2019-03-29T00:31:17Z

Andrew Branscom at 20:08, 10 March 2018

2018-03-10T20:08:15Z

Andrew Branscom: /* See Also */

2018-03-10T20:07:06Z

Andrew Branscom at 20:48, 31 July 2013

2013-07-31T20:48:50Z

Andrew Branscom at 20:48, 31 July 2013

2013-07-31T20:48:27Z

Andrew Branscom: /* Example */

2013-07-31T20:47:42Z

Example

Andrew Branscom: Created page with "NOTOC {{AGIWiki}} ''This article refers controller-command. For information about Controllers as part of an AGI game, see Controller.'' The '''controller..."

2013-07-31T20:33:43Z

Created page with "__NOTOC__ {{AGIWiki}} ''This article refers controller-command. For information about Controllers as part of an AGI game, see Controller.'' The '''controller..."

New page

__NOTOC__

{{AGIWiki}}

''This article refers controller-command. For information about Controllers as part of an AGI game, see [[Controller|Controller]].''

The '''controller''' command returns TRUE if a menu item or key assigned to the controller has been selected or pressed during the current cycle.

== Syntax ==

: controller([[Controller|ctl]] cA)

== Remarks ==

: Test commands are only valid in an ''if'' statement.

: This statement can be combined with the NOT operator (!) to test for a controller NOT being selected.

: The interpreter clears all controllers at the beginning of each cycle.

: If more than one menu or keyboard entry is assigned to the controller, it does not matter which one is selected/pressed. All of them will cause the '''controller''' command to return TRUE.

== Example ==
<syntax type="C++">
//build a simple menu structure
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()
}
</syntax>

== Technical Information ==

{| border="1" cellpadding="2"
| style="background-color: #efefef" | '''Required interpreter version'''
| Available in all AGI versions
|-
| style="background-color: #efefef" | '''Bytecode value'''
| 12 (0x0C hex)
|}

== See Also ==

* [[Controller|Controllers]]

== Sources ==

* [[WinAGI|WinAGI]] help file

[[Category:Logic Commands]]
[[Category:Test Commands]]

@@ Line 49: / Line 49: @@
 [ test for menu or keyboard selections
-if(controller(c2) {
+if(controller(c2)
    [ save game
    save.game();
-−
+  }
-if(controller(c3) {
+if(controller(c3)
    [ restore game
    restore.game()
-−
+  }
 </syntaxhighlight>

← Older revision		Revision as of 00:31, 29 March 2019
Line 1:		Line 1:
−	''This article refers controller-command. For information about Controllers as part of an AGI game, see [[Controllers]].''	+	''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]].		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]].

@@ Line 3: / Line 3: @@
 The '''controller''' command returns TRUE if a menu item or key assigned to the controller has been selected or pressed during the current cycle.
-== Syntax ==
+==<br /> Syntax ==
 : controller([[Controller|ctl]] cA)
-== Remarks ==
+==<br /> Remarks ==
 : Test commands are only valid in an ''if'' statement.
@@ Line 17: / Line 17: @@
 : If more than one menu or keyboard entry is assigned to the controller, it does not matter which one is selected/pressed. All of them will cause the '''controller''' command to return TRUE.
-== Example ==
+==<br /> Example ==
 <div class="CodeBlockHeader">Code:</div>
@@ Line 66: / Line 66: @@
 |}
-== See Also ==
+==<br /> Data types ==
-* [[Controller|Controllers]]
+{{Data Types}}
-==<br /> Data types ==
+==<br /> See Also ==
-{{Data Types}}
+* [[Controller|Controllers]]
-== Sources ==
+==<br /> Sources ==
 * [[WinAGI|WinAGI]] help file

← Older revision		Revision as of 20:07, 10 March 2018
Line 69:		Line 69:

	* [[Controller\|Controllers]]		* [[Controller\|Controllers]]
		+
		+	==<br /> Data types ==
		+
		+	{{Data Types}}

	== Sources ==		== Sources ==

@@ Line 17: / Line 17: @@
 : If more than one menu or keyboard entry is assigned to the controller, it does not matter which one is selected/pressed. All of them will cause the '''controller''' command to return TRUE.
-== Example ==<div class="CodeBlockHeader">Code:</div>
+== Example ==
 <div class="CodeBlockStyle">
 <syntaxhighlight lang="agi">

@@ Line 30: / Line 30: @@
 set.menu.item("Help    ", c1);
 set.menu("File");
-set.menu.item("Save Game      &lt;F5&gt;", c2);
+set.menu.item("Save Game      <F5>", c2);
-set.menu.item("Restore Game   &lt;F7&gt;", c3);
+set.menu.item("Restore Game   <F7>", c3);
 set.menu.item("-------------------", c20);
-set.menu.item("Restart Game   &lt;F9&gt;", c4);
+set.menu.item("Restart Game   <F9>", c4);
 set.menu.item("-------------------", c20);
-set.menu.item("Quit        &lt;Alt Z&gt;", c5);
+set.menu.item("Quit        <Alt Z>", c5);
 [ disable the separators
 disable.item(c20);

← Older revision		Revision as of 20:48, 31 July 2013
Line 1:		Line 1:
−	~~__NOTOC__~~
−
−	~~{{AGIWiki}}~~
−
	''This article refers controller-command. For information about Controllers as part of an AGI game, see [[Controller\|Controller]].''		''This article refers controller-command. For information about Controllers as part of an AGI game, see [[Controller\|Controller]].''

@@ Line 21: / Line 21: @@
 : If more than one menu or keyboard entry is assigned to the controller, it does not matter which one is selected/pressed. All of them will cause the '''controller''' command to return TRUE.
-== Example ==
+== Example ==<div class="CodeBlockHeader">Code:</div>
-<syntax type="C++">
+<div class="CodeBlockStyle">
 //build a simple menu structure
 set.menu("Info");
@@ Line 55: / Line 56: @@
    restore.game()
+}
-</syntax>
+</syntaxhighlight></div>
 == Technical Information ==

Controller - Revision history

Andrew Korson: /* Example */

Andrew Korson: /* Example */

Andrew Korson at 00:31, 29 March 2019

Andrew Korson at 00:31, 29 March 2019

Andrew Branscom at 20:08, 10 March 2018

Andrew Branscom: /* See Also */

Andrew Branscom at 20:48, 31 July 2013

Andrew Branscom at 20:48, 31 July 2013

Andrew Branscom: /* Example */

Andrew Branscom: Created page with "__NOTOC__ {{AGIWiki}} ''This article refers controller-command. For information about Controllers as part of an AGI game, see Controller.'' The '''controller..."

Andrew Branscom: Created page with "NOTOC {{AGIWiki}} ''This article refers controller-command. For information about Controllers as part of an AGI game, see Controller.'' The '''controller..."