| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215 |
- <!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: Function Categories</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="#groups">Modules</a> </div>
- <div class="headertitle"><div class="title">Function Categories</div></div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
- Modules</h2></td></tr>
- <tr class="memitem:group__AudioFunctions" id="r_group__AudioFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html">Audio</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__BoxFunctions" id="r_group__BoxFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BoxFunctions.html">Box Math</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__BuildInfoFunctions" id="r_group__BuildInfoFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html">Build Info</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__Callstack" id="r_group__Callstack"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Callstack.html">Call Stack</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__ColorFunctions" id="r_group__ColorFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ColorFunctions.html">Color</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__ConsoleOutput" id="r_group__ConsoleOutput"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html">Console Output</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__CursorManager" id="r_group__CursorManager"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CursorManager.html">Cursor Management</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__Datablocks" id="r_group__Datablocks"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Datablocks.html">Datablocks</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__EventScheduleFunctions" id="r_group__EventScheduleFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html">Event Scheduling</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__FileSystem" id="r_group__FileSystem"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html">File System</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__FontFunctions" id="r_group__FontFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html">Font</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__ImageFileManipulation" id="r_group__ImageFileManipulation"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ImageFileManipulation.html">Image File Manipulation</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__InputManagement" id="r_group__InputManagement"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__InputManagement.html">Input Management</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MacFSAA" id="r_group__MacFSAA"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MacFSAA.html">Mac Anti-Aliasing</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MathFunctions" id="r_group__MathFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html">Math (Non-Vector)</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MatrixMathFunctions" id="r_group__MatrixMathFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMathFunctions.html">Matrix Math</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MemoryFrameAllocation" id="r_group__MemoryFrameAllocation"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MemoryFrameAllocation.html">Memory Frames</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MessageBox" id="r_group__MessageBox"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageBox.html">Message Box</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MessageQueueFunctions" id="r_group__MessageQueueFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html">Message Queue (Dispatcher)</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__MetaScriptingFunctions" id="r_group__MetaScriptingFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html">Meta-Scripting</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__Network" id="r_group__Network"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Network.html">Network</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__ObjectFunctions" id="r_group__ObjectFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ObjectFunctions.html">Object</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__PackageFunctions" id="r_group__PackageFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PackageFunctions.html">Packages</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__PathExpandoFunctions" id="r_group__PathExpandoFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html">Path Expando</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__PlatformFunctions" id="r_group__PlatformFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFunctions.html">Platform</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__RandomNumbersFunctions" id="r_group__RandomNumbersFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbersFunctions.html">Random Numbers</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__ResourceManagerFunctions" id="r_group__ResourceManagerFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ResourceManagerFunctions.html">Resource Manager</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__SerializeFunctions" id="r_group__SerializeFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SerializeFunctions.html">Serialization</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__ServerQueryFunctions" id="r_group__ServerQueryFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html">Server Query</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__StringFunctions" id="r_group__StringFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html">String</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__FieldManipulatorFunctions" id="r_group__FieldManipulatorFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FieldManipulatorFunctions.html">String Fields</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__TaggedStrings" id="r_group__TaggedStrings"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__TaggedStrings.html">Tagged Strings</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__TelnetConsole" id="r_group__TelnetConsole"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__TelnetConsole.html">Telnet Console</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__TelnetDebuggerFunctions" id="r_group__TelnetDebuggerFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__TelnetDebuggerFunctions.html">Telnet Debugger</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__TextureManagerFunctions" id="r_group__TextureManagerFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__TextureManagerFunctions.html">Texture Manager</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__UnitTesting" id="r_group__UnitTesting"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__UnitTesting.html">Unit Testing</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__Utility" id="r_group__Utility"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Utility.html">Utility</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__VectorMathFunctions" id="r_group__VectorMathFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VectorMathFunctions.html">Vector Math</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__Vector2Math" id="r_group__Vector2Math"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html">Vector2 Math</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__VideoFunctions" id="r_group__VideoFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__VideoFunctions.html">Video</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group__WindowsPlatform" id="r_group__WindowsPlatform"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html">Windows Platform</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga45df3ce0e002d4ad29e9517a5f539ff1" id="r_ga45df3ce0e002d4ad29e9517a5f539ff1"><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="group__TorqueScriptFunctions.html#ga45df3ce0e002d4ad29e9517a5f539ff1">isJoystickDetected</a> ()</td></tr>
- <tr class="separator:ga45df3ce0e002d4ad29e9517a5f539ff1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga711f5ffff9a2722c404e930177aed3fc" id="r_ga711f5ffff9a2722c404e930177aed3fc"><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="group__TorqueScriptFunctions.html#ga711f5ffff9a2722c404e930177aed3fc">getJoystickAxes</a> (instance)</td></tr>
- <tr class="separator:ga711f5ffff9a2722c404e930177aed3fc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga188eaac145564a2ad5d2aab9939518bb" id="r_ga188eaac145564a2ad5d2aab9939518bb"><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="group__TorqueScriptFunctions.html#ga188eaac145564a2ad5d2aab9939518bb">getJoystickCount</a> ()</td></tr>
- <tr class="separator:ga188eaac145564a2ad5d2aab9939518bb"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>*‍/ // group VectorMathFunctions</p>
- <p>/*! </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga711f5ffff9a2722c404e930177aed3fc" name="ga711f5ffff9a2722c404e930177aed3fc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga711f5ffff9a2722c404e930177aed3fc">◆ </a></span>getJoystickAxes()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getJoystickAxes </td>
- <td>(</td>
- <td class="paramtype">instance </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the getJoystickAxes function to get the current axes position (x and y ) of any intance of a joystick. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">instance</td><td>A non-negative number value selecting a specific joystick instance attached to this computer. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns a string containing the \x y\ position of the joystick. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd>disableJoystick, enableJoystick, <a class="el" href="group__TorqueScriptFunctions.html#ga45df3ce0e002d4ad29e9517a5f539ff1">isJoystickDetected</a> </dd></dl>
- </div>
- </div>
- <a id="ga188eaac145564a2ad5d2aab9939518bb" name="ga188eaac145564a2ad5d2aab9939518bb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga188eaac145564a2ad5d2aab9939518bb">◆ </a></span>getJoystickCount()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getJoystickCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the total number of joysticks connected, both XInput and other. </p><dl class="section return"><dt>Returns</dt><dd>The number of joysticks connected. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__TorqueScriptFunctions.html#ga45df3ce0e002d4ad29e9517a5f539ff1">isJoystickDetected</a> </dd></dl>
- </div>
- </div>
- <a id="ga45df3ce0e002d4ad29e9517a5f539ff1" name="ga45df3ce0e002d4ad29e9517a5f539ff1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga45df3ce0e002d4ad29e9517a5f539ff1">◆ </a></span>isJoystickDetected()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isJoystickDetected </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>addtogroup WindowsPlatform Windows Platform</p>
- <p>Use the isJoystickDetected function to determine if one or more joysticks are connected to the system. This doesn't tell us how many joysticks there are, just that there are joysticks. It is our job to find out how many and to attach them. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if one or more joysticks are attached and detected, false otherwise. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd>disableJoystick, enableJoystick, <a class="el" href="group__TorqueScriptFunctions.html#ga711f5ffff9a2722c404e930177aed3fc">getJoystickAxes</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>
|