classAmbientForceController.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: AmbientForceController Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classAmbientForceController-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">AmbientForceController Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;AmbientForceController_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a>.</p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:a0434fc9330abb8405750f7c8196fc5a3" id="r_a0434fc9330abb8405750f7c8196fc5a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a0434fc9330abb8405750f7c8196fc5a3">getForce</a> ()</td></tr>
  55. <tr class="separator:a0434fc9330abb8405750f7c8196fc5a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a3ad349a0c6886e6008b0bf72f87b8184" id="r_a3ad349a0c6886e6008b0bf72f87b8184"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a3ad349a0c6886e6008b0bf72f87b8184">setForce</a> (float x, float y)</td></tr>
  57. <tr class="separator:a3ad349a0c6886e6008b0bf72f87b8184"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. </table>
  59. <h2 class="groupheader">Member Function Documentation</h2>
  60. <a id="a0434fc9330abb8405750f7c8196fc5a3" name="a0434fc9330abb8405750f7c8196fc5a3"></a>
  61. <h2 class="memtitle"><span class="permalink"><a href="#a0434fc9330abb8405750f7c8196fc5a3">&#9670;&#160;</a></span>getForce()</h2>
  62. <div class="memitem">
  63. <div class="memproto">
  64. <table class="memname">
  65. <tr>
  66. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getForce </td>
  67. <td>(</td>
  68. <td class="paramname"></td><td>)</td>
  69. <td></td>
  70. </tr>
  71. </table>
  72. </div><div class="memdoc">
  73. <p>Gets the ambient force being used. </p><dl class="section return"><dt>Returns</dt><dd>The ambient force being used. </dd></dl>
  74. </div>
  75. </div>
  76. <a id="a3ad349a0c6886e6008b0bf72f87b8184" name="a3ad349a0c6886e6008b0bf72f87b8184"></a>
  77. <h2 class="memtitle"><span class="permalink"><a href="#a3ad349a0c6886e6008b0bf72f87b8184">&#9670;&#160;</a></span>setForce()</h2>
  78. <div class="memitem">
  79. <div class="memproto">
  80. <table class="memname">
  81. <tr>
  82. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setForce </td>
  83. <td>(</td>
  84. <td class="paramtype">float&#160;</td>
  85. <td class="paramname"><em>x</em>, </td>
  86. </tr>
  87. <tr>
  88. <td class="paramkey"></td>
  89. <td></td>
  90. <td class="paramtype">float&#160;</td>
  91. <td class="paramname"><em>y</em>&#160;</td>
  92. </tr>
  93. <tr>
  94. <td></td>
  95. <td>)</td>
  96. <td></td><td></td>
  97. </tr>
  98. </table>
  99. </div><div class="memdoc">
  100. <p>Sets the ambient force to use. </p><dl class="params"><dt>Parameters</dt><dd>
  101. <table class="params">
  102. <tr><td class="paramname">x</td><td>The component of the ambient force along the horizontal (world) axis. </td></tr>
  103. <tr><td class="paramname">y</td><td>The component of the ambient force along the vertical (world) axis. </td></tr>
  104. </table>
  105. </dd>
  106. </dl>
  107. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  108. </div>
  109. </div>
  110. </div><!-- contents -->
  111. <!-- start footer part -->
  112. <hr class="footer"/><address class="footer"><small>
  113. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  114. </small></address>
  115. </body>
  116. </html>