| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>TorqueScript Reference: ActionMap Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classActionMap-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ActionMap Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <actionMap_ScriptBinding.h></code></p>
- <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a6002941c1fc3155bb354fea4a22f7c54" id="r_a6002941c1fc3155bb354fea4a22f7c54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a> (device, action, [modifier, mod...], command)</td></tr>
- <tr class="separator:a6002941c1fc3155bb354fea4a22f7c54"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad11f018ebdf715aadcf19e64a68d7348" id="r_ad11f018ebdf715aadcf19e64a68d7348"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> (device, action, makeCmd, breakCmd)</td></tr>
- <tr class="separator:ad11f018ebdf715aadcf19e64a68d7348"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2971a79342ed9b279b240dc47139b3a4" id="r_a2971a79342ed9b279b240dc47139b3a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a2971a79342ed9b279b240dc47139b3a4">bindObj</a> (device, action, [modifier spec, mod...], command, object)</td></tr>
- <tr class="separator:a2971a79342ed9b279b240dc47139b3a4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a614a2ea8ff181dc41c59ec40fb3122ee" id="r_a614a2ea8ff181dc41c59ec40fb3122ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a614a2ea8ff181dc41c59ec40fb3122ee">getBinding</a> (command)</td></tr>
- <tr class="separator:a614a2ea8ff181dc41c59ec40fb3122ee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2b9b69e8d6c701e3666ac446a853901d" id="r_a2b9b69e8d6c701e3666ac446a853901d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a2b9b69e8d6c701e3666ac446a853901d">getCommand</a> (device, action)</td></tr>
- <tr class="separator:a2b9b69e8d6c701e3666ac446a853901d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a44b8fde629f51c090773f6fa56a5628c" id="r_a44b8fde629f51c090773f6fa56a5628c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a44b8fde629f51c090773f6fa56a5628c">getDeadZone</a> (device, action)</td></tr>
- <tr class="separator:a44b8fde629f51c090773f6fa56a5628c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a39de83bee583b0c8b2783d7e33423109" id="r_a39de83bee583b0c8b2783d7e33423109"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a39de83bee583b0c8b2783d7e33423109">getScale</a> (device, action)</td></tr>
- <tr class="separator:a39de83bee583b0c8b2783d7e33423109"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4168e5ca3f24d30b4f7534a4cc55a86e" id="r_a4168e5ca3f24d30b4f7534a4cc55a86e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a4168e5ca3f24d30b4f7534a4cc55a86e">isInverted</a> (device, action)</td></tr>
- <tr class="separator:a4168e5ca3f24d30b4f7534a4cc55a86e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a312e7f6c761a199c1369fbe651e084f0" id="r_a312e7f6c761a199c1369fbe651e084f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a312e7f6c761a199c1369fbe651e084f0">pop</a> ()</td></tr>
- <tr class="separator:a312e7f6c761a199c1369fbe651e084f0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a98b45e0a7ed122b6710df00209b67827" id="r_a98b45e0a7ed122b6710df00209b67827"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a98b45e0a7ed122b6710df00209b67827">push</a> ()</td></tr>
- <tr class="separator:a98b45e0a7ed122b6710df00209b67827"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aba70d852a967c89a18a2dbf4cb117927" id="r_aba70d852a967c89a18a2dbf4cb117927"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#aba70d852a967c89a18a2dbf4cb117927">save</a> ([<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>][, append])</td></tr>
- <tr class="separator:aba70d852a967c89a18a2dbf4cb117927"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa5d2f9815fbd6b12e9e923692d3d7c87" id="r_aa5d2f9815fbd6b12e9e923692d3d7c87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> (device, action)</td></tr>
- <tr class="separator:aa5d2f9815fbd6b12e9e923692d3d7c87"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abcd284cf37de45f782dea6b79843b663" id="r_abcd284cf37de45f782dea6b79843b663"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#abcd284cf37de45f782dea6b79843b663">unbindObj</a> (device, action, object)</td></tr>
- <tr class="separator:abcd284cf37de45f782dea6b79843b663"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <tr class="memitem:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject" id="r_a2375929bea4901d98ae352231b0721ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject" id="r_a22437f451ceb1429fa2a3be23d523954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
- <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject" id="r_a7a4721d0a51e952c211e9b0fea4d8090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
- <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject" id="r_a929e1325a515b279faca90a65028782e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
- <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject" id="r_a4f673cd959711ae09927e7c44dae5fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
- <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject" id="r_a78ee178b6a73658d65ca60da4d1e6683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
- <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject" id="r_ab8b0f8b874af628d7204d9cc2630ced7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
- <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject" id="r_a6e266d4432d70cad58461d96e1d2cbdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject" id="r_a847e859bcc5b58df83fa7f331c167c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
- <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject" id="r_a9cbf471b97387d5bdefb88f92094ad54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject" id="r_a8f4e85d0903526235ed2ca86df69cdef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
- <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject" id="r_a9ce8801999cf2228ddde6d58ca3773d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
- <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
- <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
- <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject" id="r_a66ac731a8dc088fe8c8ab17bf7c9eecd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
- <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject" id="r_a3e97a324df2af082cdb089491757ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
- <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject" id="r_abc2222a9649b5c033810e753b07f26a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
- <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject" id="r_a1084f1964e446b3d279943cf6e575069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject" id="r_ab4e32fb984d9ce6584b0fa57c8772d3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject" id="r_a7543b8dc494ec0d9034cb73ae504f3ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
- <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject" id="r_a0e143217119b68d557d17ac2f13b173e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
- <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject" id="r_af2e74f6b683da8d2085f0991dab7948b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
- <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject" id="r_ac636f89189406eef1b401292459b1a3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
- <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject" id="r_aa8f68d1e6d8c6601c39b3f676f0e9c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
- <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject" id="r_a88c8d99755a07ac4648360dd40ff67a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
- <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject" id="r_a367706e675179342e6153c45f1ba06ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
- <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject" id="r_a0570b7f6eb94a0ed941fd75f6f01555b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
- <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject" id="r_a5aaca360a719feabae0e4e57b921deae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
- <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject" id="r_af9f341b474a28f4bcf79bc02439b7c18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
- <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject" id="r_a986f1b4a76969bac5dfd50b22af8dec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
- <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject" id="r_ae329d6593bb3f9b8046e7cae693ccc09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
- <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject" id="r_a39653bc04e82875f2dc8d6dea25acdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
- <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject" id="r_aa6f6bfef028c7b053444cbd48567d286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
- <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject" id="r_a5807c03d2b725a54732d09b53d5da631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
- <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject" id="r_a16d537cd7a1c438045bb756fe1e22d2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
- <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject" id="r_a9f05bc4a94b98e2e3347fe34aeefe7c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject" id="r_a3f7f0520846a222310415ad7a8f8a4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject" id="r_afa6eac5990b02024e77e3815161159df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject" id="r_a07dd4cf0d113ff4a8943b900bda68a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
- <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject" id="r_a1dcaa2910d6405134c74a71745d29154"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1dcaa2910d6405134c74a71745d29154">postEvent</a> (<a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eventName, <a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> data)</td></tr>
- <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject" id="r_ab6e816c3694e8b6119bf9ac3f5556f32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
- <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject" id="r_a216228c27df224ac5e8d3590494bfb3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject" id="r_ad517bd83c1c853985ab07cd22775c43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a6002941c1fc3155bb354fea4a22f7c54" name="a6002941c1fc3155bb354fea4a22f7c54"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6002941c1fc3155bb354fea4a22f7c54">◆ </a></span>bind()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> bind </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">command </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the bind method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bind the command to. </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for. </td></tr>
- <tr><td class="paramname">modifier</td><td>Special modifiers (mouse only), such as dead spot, etc. </td></tr>
- <tr><td class="paramname">command</td><td>The function to be called on make and break. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a>, <a class="el" href="classActionMap.html#a614a2ea8ff181dc41c59ec40fb3122ee">getBinding</a>, <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> </dd></dl>
- </div>
- </div>
- <a id="ad11f018ebdf715aadcf19e64a68d7348" name="ad11f018ebdf715aadcf19e64a68d7348"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad11f018ebdf715aadcf19e64a68d7348">◆ </a></span>bindCmd()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> bindCmd </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">makeCmd </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">breakCmd </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the bindCmd method to associate up to two functions to a keystroke or other device input. The makeCmd is bound to the make event and the breakCmd is bound to the break event and in both cases, the commands are specified as complete scripts, with all arguments, elipses, and the terminating semi-colon. Either of these commands may be non-specified (NULL strings). For clarification, see 'Bind Sample' example below. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bind the command to (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for(see 'Action Table' below). </td></tr>
- <tr><td class="paramname">makeCmd</td><td>The function to be called on make event. </td></tr>
- <tr><td class="paramname">breakCmd</td><td>The function to be called on break event. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#a614a2ea8ff181dc41c59ec40fb3122ee">getBinding</a>, <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> </dd></dl>
- </div>
- </div>
- <a id="a2971a79342ed9b279b240dc47139b3a4" name="a2971a79342ed9b279b240dc47139b3a4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2971a79342ed9b279b240dc47139b3a4">◆ </a></span>bindObj()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> bindObj </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">command </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">object </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the bindObj method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bind the command to. </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for. </td></tr>
- <tr><td class="paramname">modifier</td><td>Special modifiers (mouse only), such as dead spot, etc. </td></tr>
- <tr><td class="paramname">command</td><td>The function to be called on make and break. </td></tr>
- <tr><td class="paramname">object</td><td>The explicit object (it defaults to NULL when you call <a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind()</a> ) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a>, <a class="el" href="classActionMap.html#a614a2ea8ff181dc41c59ec40fb3122ee">getBinding</a>, <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> </dd></dl>
- </div>
- </div>
- <a id="a614a2ea8ff181dc41c59ec40fb3122ee" name="a614a2ea8ff181dc41c59ec40fb3122ee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a614a2ea8ff181dc41c59ec40fb3122ee">◆ </a></span>getBinding()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getBinding </td>
- <td>(</td>
- <td class="paramtype">command </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the getBinding method to get the binding for a specified command. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">command</td><td>The function to seek a binding for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns a string containing the binding as a field (TAB separated string), or a NULL string meaning 'no binding found'. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
- </div>
- </div>
- <a id="a2b9b69e8d6c701e3666ac446a853901d" name="a2b9b69e8d6c701e3666ac446a853901d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2b9b69e8d6c701e3666ac446a853901d">◆ </a></span>getCommand()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCommand </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the getCommand method to get the function associated with a specific device + action pair. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the function name or specification associated with the specified device + action pair, or a NULL-string meaning 'no binding found'. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a>, <a class="el" href="classActionMap.html#a614a2ea8ff181dc41c59ec40fb3122ee">getBinding</a> </dd></dl>
- </div>
- </div>
- <a id="a44b8fde629f51c090773f6fa56a5628c" name="a44b8fde629f51c090773f6fa56a5628c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a44b8fde629f51c090773f6fa56a5628c">◆ </a></span>getDeadZone()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDeadZone </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the getDeadZone method to get the dead-zone associated with a specific device + action pair. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns a dead-zone specification, or \0 0\ meaning that there is no dead-zone, or a NULL string meaning the mapping was not found. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
- </div>
- </div>
- <a id="a39de83bee583b0c8b2783d7e33423109" name="a39de83bee583b0c8b2783d7e33423109"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a39de83bee583b0c8b2783d7e33423109">◆ </a></span>getScale()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getScale </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the getScale method to get the scale associated with a specific device + action pair. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns 1 if no scale is associated with the specified device + action pair, or the mapping was not found. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
- </div>
- </div>
- <a id="a4168e5ca3f24d30b4f7534a4cc55a86e" name="a4168e5ca3f24d30b4f7534a4cc55a86e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4168e5ca3f24d30b4f7534a4cc55a86e">◆ </a></span>isInverted()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isInverted </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the Purpose method to determine if a specific device + action pair in inverted. This only applies to scrolling devices. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns 1 if the mouse (or other scrolling device) is inverted, 0 otherwise. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
- </div>
- </div>
- <a id="a312e7f6c761a199c1369fbe651e084f0" name="a312e7f6c761a199c1369fbe651e084f0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a312e7f6c761a199c1369fbe651e084f0">◆ </a></span>pop()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> pop </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the pop method to de-activate an <a class="el" href="classActionMap.html">ActionMap</a> and remove it from non-global <a class="el" href="classActionMap.html">ActionMap</a> stack. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a98b45e0a7ed122b6710df00209b67827">push</a> </dd></dl>
- </div>
- </div>
- <a id="a98b45e0a7ed122b6710df00209b67827" name="a98b45e0a7ed122b6710df00209b67827"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a98b45e0a7ed122b6710df00209b67827">◆ </a></span>push()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> push </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the push method to activate an <a class="el" href="classActionMap.html">ActionMap</a> and place it at the top of the non-global <a class="el" href="classActionMap.html">ActionMap</a> stack. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a312e7f6c761a199c1369fbe651e084f0">pop</a> </dd></dl>
- </div>
- </div>
- <a id="aba70d852a967c89a18a2dbf4cb117927" name="aba70d852a967c89a18a2dbf4cb117927"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aba70d852a967c89a18a2dbf4cb117927">◆ </a></span>save()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> save </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the save method to save an entire action map specification to a file. If append is not specified, or specified as false, fileName will be overwritten, otherwise the action map will be appended to the file. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>Full path to file in which to store action map definition. </td></tr>
- <tr><td class="paramname">append</td><td>If true, do not overwrite the file, else start from scratch. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a id="aa5d2f9815fbd6b12e9e923692d3d7c87" name="aa5d2f9815fbd6b12e9e923692d3d7c87"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa5d2f9815fbd6b12e9e923692d3d7c87">◆ </a></span>unbind()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> unbind </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the unbind method to remove a previosly specified device + action pair from the action map. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
- </div>
- </div>
- <a id="abcd284cf37de45f782dea6b79843b663" name="abcd284cf37de45f782dea6b79843b663"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abcd284cf37de45f782dea6b79843b663">◆ </a></span>unbindObj()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> unbindObj </td>
- <td>(</td>
- <td class="paramtype">device </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">action </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">object </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the unbind method to remove a previosly specified device + action pair from the action map. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
- <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
- <tr><td class="paramname">object</td><td>Explicit object (it defaults to NULL when you call <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind()</a> ). </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classActionMap.html#a6002941c1fc3155bb354fea4a22f7c54">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|