group__MathFunctions.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921
  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: Math (Non-Vector)</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="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">Math (Non-Vector)<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:ga2106631b7788822a95367b32142999eb" id="r_ga2106631b7788822a95367b32142999eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga2106631b7788822a95367b32142999eb">addBitToMask</a> (mask, <a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>)</td></tr>
  52. <tr class="separator:ga2106631b7788822a95367b32142999eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga7763021eda6826df8311f3506707206e" id="r_ga7763021eda6826df8311f3506707206e"><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="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a> ()</td></tr>
  54. <tr class="separator:ga7763021eda6826df8311f3506707206e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:ga061a743f758efc28b3abfcda018ce5f8" id="r_ga061a743f758efc28b3abfcda018ce5f8"><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="group__MathFunctions.html#ga061a743f758efc28b3abfcda018ce5f8">bitInverse</a> ()</td></tr>
  56. <tr class="separator:ga061a743f758efc28b3abfcda018ce5f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga226a173fecd58ccc2b66e185111a23ef" id="r_ga226a173fecd58ccc2b66e185111a23ef"><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="group__MathFunctions.html#ga226a173fecd58ccc2b66e185111a23ef">bits</a> ()</td></tr>
  58. <tr class="separator:ga226a173fecd58ccc2b66e185111a23ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:gae3d373c8e4f47876e79580255fda09ca" id="r_gae3d373c8e4f47876e79580255fda09ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gae3d373c8e4f47876e79580255fda09ca">mAbs</a> (val)</td></tr>
  60. <tr class="separator:gae3d373c8e4f47876e79580255fda09ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:gada34c6c74dfdcb11cbcfd8fa93723ae9" id="r_gada34c6c74dfdcb11cbcfd8fa93723ae9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gada34c6c74dfdcb11cbcfd8fa93723ae9">mAcos</a> (val)</td></tr>
  62. <tr class="separator:gada34c6c74dfdcb11cbcfd8fa93723ae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ga220952eb9eac31d3adffd769b82672a3" id="r_ga220952eb9eac31d3adffd769b82672a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga220952eb9eac31d3adffd769b82672a3">mAsin</a> (val)</td></tr>
  64. <tr class="separator:ga220952eb9eac31d3adffd769b82672a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:gac7909662d8361784ac11b2343b9cb9cf" id="r_gac7909662d8361784ac11b2343b9cb9cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gac7909662d8361784ac11b2343b9cb9cf">mAtan</a> (val)</td></tr>
  66. <tr class="separator:gac7909662d8361784ac11b2343b9cb9cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ga0003814a0ab34f56c612bf415df188f4" id="r_ga0003814a0ab34f56c612bf415df188f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga0003814a0ab34f56c612bf415df188f4">mCeil</a> (val)</td></tr>
  68. <tr class="separator:ga0003814a0ab34f56c612bf415df188f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:gad89b62df29c737c57d22c63a534817fe" id="r_gad89b62df29c737c57d22c63a534817fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad89b62df29c737c57d22c63a534817fe">mClamp</a> (float number, float min, float max)</td></tr>
  70. <tr class="separator:gad89b62df29c737c57d22c63a534817fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga57830e6b2dbe67572482a4b5484ff68a" id="r_ga57830e6b2dbe67572482a4b5484ff68a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga57830e6b2dbe67572482a4b5484ff68a">mCos</a> (val)</td></tr>
  72. <tr class="separator:ga57830e6b2dbe67572482a4b5484ff68a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:gaf502c5c8f38d39a4027bfcdb54d4a573" id="r_gaf502c5c8f38d39a4027bfcdb54d4a573"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf502c5c8f38d39a4027bfcdb54d4a573">mDegToRad</a> (val)</td></tr>
  74. <tr class="separator:gaf502c5c8f38d39a4027bfcdb54d4a573"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga10f33dc8c25d218ff0184fc9349d7fee" id="r_ga10f33dc8c25d218ff0184fc9349d7fee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga10f33dc8c25d218ff0184fc9349d7fee">mEase</a> (easeFunction, progress)</td></tr>
  76. <tr class="separator:ga10f33dc8c25d218ff0184fc9349d7fee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga2d1f398ae7b17b53b522c761f4678b4d" id="r_ga2d1f398ae7b17b53b522c761f4678b4d"><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="group__MathFunctions.html#ga2d1f398ae7b17b53b522c761f4678b4d">mFloatLength</a> (val, numDecimals)</td></tr>
  78. <tr class="separator:ga2d1f398ae7b17b53b522c761f4678b4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ga4212b2d30f340138e6472fe7224116d8" id="r_ga4212b2d30f340138e6472fe7224116d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga4212b2d30f340138e6472fe7224116d8">mFloor</a> (val)</td></tr>
  80. <tr class="separator:ga4212b2d30f340138e6472fe7224116d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga27c1afd89a939bd1cc141b78cbbe3de1" id="r_ga27c1afd89a939bd1cc141b78cbbe3de1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga27c1afd89a939bd1cc141b78cbbe3de1">mGetMax</a> (a, b)</td></tr>
  82. <tr class="separator:ga27c1afd89a939bd1cc141b78cbbe3de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:gad8cf7b1316e3eab55592adc8fa1edcbc" id="r_gad8cf7b1316e3eab55592adc8fa1edcbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad8cf7b1316e3eab55592adc8fa1edcbc">mGetMin</a> (a, b)</td></tr>
  84. <tr class="separator:gad8cf7b1316e3eab55592adc8fa1edcbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga7d80549c4e47c06c3bcb009c742ab367" id="r_ga7d80549c4e47c06c3bcb009c742ab367"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga7d80549c4e47c06c3bcb009c742ab367">mLog</a> (val)</td></tr>
  86. <tr class="separator:ga7d80549c4e47c06c3bcb009c742ab367"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:gaaf03cec597971519aa33dfc8de539ad4" id="r_gaaf03cec597971519aa33dfc8de539ad4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaaf03cec597971519aa33dfc8de539ad4">mPow</a> (val, power)</td></tr>
  88. <tr class="separator:gaaf03cec597971519aa33dfc8de539ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga1d996a02e1ddbc2328a7058cec119576" id="r_ga1d996a02e1ddbc2328a7058cec119576"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga1d996a02e1ddbc2328a7058cec119576">mRadToDeg</a> (val)</td></tr>
  90. <tr class="separator:ga1d996a02e1ddbc2328a7058cec119576"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:gaa532d15c461ad665c6ca1f208f4edb99" id="r_gaa532d15c461ad665c6ca1f208f4edb99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaa532d15c461ad665c6ca1f208f4edb99">mRound</a> (float v)</td></tr>
  92. <tr class="separator:gaa532d15c461ad665c6ca1f208f4edb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:gad4dee8264c82983c08d48ec494a6345a" id="r_gad4dee8264c82983c08d48ec494a6345a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad4dee8264c82983c08d48ec494a6345a">mSin</a> (val)</td></tr>
  94. <tr class="separator:gad4dee8264c82983c08d48ec494a6345a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga0905f7ed2523c11ab28215969d34e8f9" id="r_ga0905f7ed2523c11ab28215969d34e8f9"><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="group__MathFunctions.html#ga0905f7ed2523c11ab28215969d34e8f9">mSolveCubic</a> (float a, float b, float c, float d)</td></tr>
  96. <tr class="separator:ga0905f7ed2523c11ab28215969d34e8f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ga76d1f6e842a6a9d50dedf4589739b422" id="r_ga76d1f6e842a6a9d50dedf4589739b422"><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="group__MathFunctions.html#ga76d1f6e842a6a9d50dedf4589739b422">mSolveQuadratic</a> (float a, float b, float c)</td></tr>
  98. <tr class="separator:ga76d1f6e842a6a9d50dedf4589739b422"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ga9a6bd90dad704a305b65bfafd1872ead" id="r_ga9a6bd90dad704a305b65bfafd1872ead"><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="group__MathFunctions.html#ga9a6bd90dad704a305b65bfafd1872ead">mSolveQuartic</a> (float a, float b, float c, float d, float e)</td></tr>
  100. <tr class="separator:ga9a6bd90dad704a305b65bfafd1872ead"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:gaf1f8e9ea7921dec013f9e691df32b572" id="r_gaf1f8e9ea7921dec013f9e691df32b572"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf1f8e9ea7921dec013f9e691df32b572">mSqrt</a> (val)</td></tr>
  102. <tr class="separator:gaf1f8e9ea7921dec013f9e691df32b572"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ga0c29659486a06c868277811e71d55a75" id="r_ga0c29659486a06c868277811e71d55a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga0c29659486a06c868277811e71d55a75">mTan</a> (val)</td></tr>
  104. <tr class="separator:ga0c29659486a06c868277811e71d55a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ga8a88d5cab721957271edb846e2cde879" id="r_ga8a88d5cab721957271edb846e2cde879"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga8a88d5cab721957271edb846e2cde879">removeBitFromMask</a> (mask, <a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>)</td></tr>
  106. <tr class="separator:ga8a88d5cab721957271edb846e2cde879"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <h2 class="groupheader">Function Documentation</h2>
  110. <a id="ga2106631b7788822a95367b32142999eb" name="ga2106631b7788822a95367b32142999eb"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#ga2106631b7788822a95367b32142999eb">&#9670;&#160;</a></span>addBitToMask()</h2>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> addBitToMask </td>
  117. <td>(</td>
  118. <td class="paramtype">mask&#160;</td>
  119. <td class="paramname">, </td>
  120. </tr>
  121. <tr>
  122. <td class="paramkey"></td>
  123. <td></td>
  124. <td class="paramtype"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>&#160;</td>
  125. <td class="paramname">&#160;</td>
  126. </tr>
  127. <tr>
  128. <td></td>
  129. <td>)</td>
  130. <td></td><td></td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>Returns the mask with a bit added to it </p>
  135. </div>
  136. </div>
  137. <a id="ga7763021eda6826df8311f3506707206e" name="ga7763021eda6826df8311f3506707206e"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#ga7763021eda6826df8311f3506707206e">&#9670;&#160;</a></span>bit()</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bit </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>Converts a bit-position into a value. </p>
  151. </div>
  152. </div>
  153. <a id="ga061a743f758efc28b3abfcda018ce5f8" name="ga061a743f758efc28b3abfcda018ce5f8"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#ga061a743f758efc28b3abfcda018ce5f8">&#9670;&#160;</a></span>bitInverse()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bitInverse </td>
  160. <td>(</td>
  161. <td class="paramname"></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Returns the ones complement of a bit. </p>
  167. </div>
  168. </div>
  169. <a id="ga226a173fecd58ccc2b66e185111a23ef" name="ga226a173fecd58ccc2b66e185111a23ef"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#ga226a173fecd58ccc2b66e185111a23ef">&#9670;&#160;</a></span>bits()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bits </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Converts a list of bit-positions into a value. </p>
  183. </div>
  184. </div>
  185. <a id="gae3d373c8e4f47876e79580255fda09ca" name="gae3d373c8e4f47876e79580255fda09ca"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#gae3d373c8e4f47876e79580255fda09ca">&#9670;&#160;</a></span>mAbs()</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAbs </td>
  192. <td>(</td>
  193. <td class="paramtype">val&#160;</td>
  194. <td class="paramname"></td><td>)</td>
  195. <td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Use the mAbs function to get the magnitude of val. </p><dl class="params"><dt>Parameters</dt><dd>
  200. <table class="params">
  201. <tr><td class="paramname">val</td><td>An integer or a floating-point value. </td></tr>
  202. </table>
  203. </dd>
  204. </dl>
  205. <dl class="section return"><dt>Returns</dt><dd>Returns the magnitude of val </dd></dl>
  206. </div>
  207. </div>
  208. <a id="gada34c6c74dfdcb11cbcfd8fa93723ae9" name="gada34c6c74dfdcb11cbcfd8fa93723ae9"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#gada34c6c74dfdcb11cbcfd8fa93723ae9">&#9670;&#160;</a></span>mAcos()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAcos </td>
  215. <td>(</td>
  216. <td class="paramtype">val&#160;</td>
  217. <td class="paramname"></td><td>)</td>
  218. <td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Use the mAcos function to get the inverse cosine of val in degrees. </p><dl class="params"><dt>Parameters</dt><dd>
  223. <table class="params">
  224. <tr><td class="paramname">val</td><td>A value between -1.0 and 1.0 equal to the cosine of some angle theta. </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. <dl class="section return"><dt>Returns</dt><dd>Returns the inverse cosine of val in radians. This value will be in the range [ 0 , 180 ]. </dd></dl>
  229. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga57830e6b2dbe67572482a4b5484ff68a">mCos</a> </dd></dl>
  230. </div>
  231. </div>
  232. <a id="ga220952eb9eac31d3adffd769b82672a3" name="ga220952eb9eac31d3adffd769b82672a3"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#ga220952eb9eac31d3adffd769b82672a3">&#9670;&#160;</a></span>mAsin()</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAsin </td>
  239. <td>(</td>
  240. <td class="paramtype">val&#160;</td>
  241. <td class="paramname"></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Use the mAsin function to get the inverse sine of val in degrees. </p><dl class="params"><dt>Parameters</dt><dd>
  247. <table class="params">
  248. <tr><td class="paramname">val</td><td>A value between -1.0 and 1.0 equal to the sine of some angle theta. </td></tr>
  249. </table>
  250. </dd>
  251. </dl>
  252. <dl class="section return"><dt>Returns</dt><dd>Returns the inverse sine of val in degrees. This value will be in the range [ -90, 90 ]. </dd></dl>
  253. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gad4dee8264c82983c08d48ec494a6345a">mSin</a> </dd></dl>
  254. </div>
  255. </div>
  256. <a id="gac7909662d8361784ac11b2343b9cb9cf" name="gac7909662d8361784ac11b2343b9cb9cf"></a>
  257. <h2 class="memtitle"><span class="permalink"><a href="#gac7909662d8361784ac11b2343b9cb9cf">&#9670;&#160;</a></span>mAtan()</h2>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAtan </td>
  263. <td>(</td>
  264. <td class="paramtype">val&#160;</td>
  265. <td class="paramname"></td><td>)</td>
  266. <td></td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. <p>Use the mAtan function to get the inverse tangent of rise/run in degrees. May be called as mAtan( deltaX, deltaY ) or mAtan( "deltaX deltaY" ). </p><dl class="params"><dt>Parameters</dt><dd>
  271. <table class="params">
  272. <tr><td class="paramname">x-axis</td><td>run Horizontal component of a line. </td></tr>
  273. <tr><td class="paramname">y-axis</td><td>rise Vertical component of a line. </td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. <dl class="section return"><dt>Returns</dt><dd>Returns the slope in degrees (the arc-tangent) of a line with the given run and rise. </dd></dl>
  278. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga0c29659486a06c868277811e71d55a75">mTan</a> </dd></dl>
  279. </div>
  280. </div>
  281. <a id="ga0003814a0ab34f56c612bf415df188f4" name="ga0003814a0ab34f56c612bf415df188f4"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#ga0003814a0ab34f56c612bf415df188f4">&#9670;&#160;</a></span>mCeil()</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> mCeil </td>
  288. <td>(</td>
  289. <td class="paramtype">val&#160;</td>
  290. <td class="paramname"></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Use the mCeil function to calculate the next highest integer value from val. </p><dl class="params"><dt>Parameters</dt><dd>
  296. <table class="params">
  297. <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
  298. </table>
  299. </dd>
  300. </dl>
  301. <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next highest integer from val. </dd></dl>
  302. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga4212b2d30f340138e6472fe7224116d8">mFloor</a> </dd></dl>
  303. </div>
  304. </div>
  305. <a id="gad89b62df29c737c57d22c63a534817fe" name="gad89b62df29c737c57d22c63a534817fe"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#gad89b62df29c737c57d22c63a534817fe">&#9670;&#160;</a></span>mClamp()</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mClamp </td>
  312. <td>(</td>
  313. <td class="paramtype">float&#160;</td>
  314. <td class="paramname"><em>number</em>, </td>
  315. </tr>
  316. <tr>
  317. <td class="paramkey"></td>
  318. <td></td>
  319. <td class="paramtype">float&#160;</td>
  320. <td class="paramname"><em>min</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">float&#160;</td>
  326. <td class="paramname"><em>max</em>&#160;</td>
  327. </tr>
  328. <tr>
  329. <td></td>
  330. <td>)</td>
  331. <td></td><td></td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Clamp a value between two other values. </p><dl class="params"><dt>Parameters</dt><dd>
  336. <table class="params">
  337. <tr><td class="paramname">number</td><td>A float value representing the number to clamp </td></tr>
  338. <tr><td class="paramname">min</td><td>The lower bound </td></tr>
  339. <tr><td class="paramname">max</td><td>The upper bound </td></tr>
  340. </table>
  341. </dd>
  342. </dl>
  343. <dl class="section return"><dt>Returns</dt><dd>A float value the is within the given range </dd></dl>
  344. </div>
  345. </div>
  346. <a id="ga57830e6b2dbe67572482a4b5484ff68a" name="ga57830e6b2dbe67572482a4b5484ff68a"></a>
  347. <h2 class="memtitle"><span class="permalink"><a href="#ga57830e6b2dbe67572482a4b5484ff68a">&#9670;&#160;</a></span>mCos()</h2>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mCos </td>
  353. <td>(</td>
  354. <td class="paramtype">val&#160;</td>
  355. <td class="paramname"></td><td>)</td>
  356. <td></td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Use the mCos function to get the cosine of the angle val. </p><dl class="params"><dt>Parameters</dt><dd>
  361. <table class="params">
  362. <tr><td class="paramname">val</td><td>A value in degrees. </td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. <dl class="section return"><dt>Returns</dt><dd>Returns the cosine of val. This value will be in the range [ -1.0 , 1.0 ]. </dd></dl>
  367. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gada34c6c74dfdcb11cbcfd8fa93723ae9">mAcos</a> </dd></dl>
  368. </div>
  369. </div>
  370. <a id="gaf502c5c8f38d39a4027bfcdb54d4a573" name="gaf502c5c8f38d39a4027bfcdb54d4a573"></a>
  371. <h2 class="memtitle"><span class="permalink"><a href="#gaf502c5c8f38d39a4027bfcdb54d4a573">&#9670;&#160;</a></span>mDegToRad()</h2>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mDegToRad </td>
  377. <td>(</td>
  378. <td class="paramtype">val&#160;</td>
  379. <td class="paramname"></td><td>)</td>
  380. <td></td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>Use the mDegToRad function to convert degrees to radians. </p><dl class="params"><dt>Parameters</dt><dd>
  385. <table class="params">
  386. <tr><td class="paramname">val</td><td>A floating-point number representing some number of degrees. </td></tr>
  387. </table>
  388. </dd>
  389. </dl>
  390. <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the degree value val in radians. </dd></dl>
  391. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga1d996a02e1ddbc2328a7058cec119576">mRadToDeg</a> </dd></dl>
  392. </div>
  393. </div>
  394. <a id="ga10f33dc8c25d218ff0184fc9349d7fee" name="ga10f33dc8c25d218ff0184fc9349d7fee"></a>
  395. <h2 class="memtitle"><span class="permalink"><a href="#ga10f33dc8c25d218ff0184fc9349d7fee">&#9670;&#160;</a></span>mEase()</h2>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mEase </td>
  401. <td>(</td>
  402. <td class="paramtype">easeFunction&#160;</td>
  403. <td class="paramname">, </td>
  404. </tr>
  405. <tr>
  406. <td class="paramkey"></td>
  407. <td></td>
  408. <td class="paramtype">progress&#160;</td>
  409. <td class="paramname">&#160;</td>
  410. </tr>
  411. <tr>
  412. <td></td>
  413. <td>)</td>
  414. <td></td><td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Given a linear progress from 0 to 1, the ease function returns an "eased" version of that progress. The returned value might be outside of 0 and 1. </p><dl class="params"><dt>Parameters</dt><dd>
  419. <table class="params">
  420. <tr><td class="paramname">easeFunction</td><td>The name of the easing function to use. Possible values include EaseIn, EaseOut, EaseInOut and postfix versions of Back, Elastic, and Bounce (i.e. EaseInBounce). </td></tr>
  421. <tr><td class="paramname">progress</td><td>Linear progress from 0 to 1. </td></tr>
  422. </table>
  423. </dd>
  424. </dl>
  425. <dl class="section return"><dt>Returns</dt><dd>An eased progress from 0 to 1 (although the value might go outside of 0 and 1). </dd></dl>
  426. </div>
  427. </div>
  428. <a id="ga2d1f398ae7b17b53b522c761f4678b4d" name="ga2d1f398ae7b17b53b522c761f4678b4d"></a>
  429. <h2 class="memtitle"><span class="permalink"><a href="#ga2d1f398ae7b17b53b522c761f4678b4d">&#9670;&#160;</a></span>mFloatLength()</h2>
  430. <div class="memitem">
  431. <div class="memproto">
  432. <table class="memname">
  433. <tr>
  434. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mFloatLength </td>
  435. <td>(</td>
  436. <td class="paramtype">val&#160;</td>
  437. <td class="paramname">, </td>
  438. </tr>
  439. <tr>
  440. <td class="paramkey"></td>
  441. <td></td>
  442. <td class="paramtype">numDecimals&#160;</td>
  443. <td class="paramname">&#160;</td>
  444. </tr>
  445. <tr>
  446. <td></td>
  447. <td>)</td>
  448. <td></td><td></td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>Use the mFloatLength function to limit the number of decimal places in val to numDecimals. </p><dl class="params"><dt>Parameters</dt><dd>
  453. <table class="params">
  454. <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
  455. <tr><td class="paramname">numDecimals</td><td>An integer between 0 and inf representing the number of decimal places to allow val to have. </td></tr>
  456. </table>
  457. </dd>
  458. </dl>
  459. <dl class="section return"><dt>Returns</dt><dd>Returns a floating-point value equivalent to a truncated version of val, where the new version has numDecimals decimal places </dd></dl>
  460. </div>
  461. </div>
  462. <a id="ga4212b2d30f340138e6472fe7224116d8" name="ga4212b2d30f340138e6472fe7224116d8"></a>
  463. <h2 class="memtitle"><span class="permalink"><a href="#ga4212b2d30f340138e6472fe7224116d8">&#9670;&#160;</a></span>mFloor()</h2>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <table class="memname">
  467. <tr>
  468. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> mFloor </td>
  469. <td>(</td>
  470. <td class="paramtype">val&#160;</td>
  471. <td class="paramname"></td><td>)</td>
  472. <td></td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. <p>Use the mFloor function to calculate the next lowest integer value from val. </p><dl class="params"><dt>Parameters</dt><dd>
  477. <table class="params">
  478. <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
  479. </table>
  480. </dd>
  481. </dl>
  482. <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next lowest integer from val. </dd></dl>
  483. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga0003814a0ab34f56c612bf415df188f4">mCeil</a> </dd></dl>
  484. </div>
  485. </div>
  486. <a id="ga27c1afd89a939bd1cc141b78cbbe3de1" name="ga27c1afd89a939bd1cc141b78cbbe3de1"></a>
  487. <h2 class="memtitle"><span class="permalink"><a href="#ga27c1afd89a939bd1cc141b78cbbe3de1">&#9670;&#160;</a></span>mGetMax()</h2>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mGetMax </td>
  493. <td>(</td>
  494. <td class="paramtype">a&#160;</td>
  495. <td class="paramname">, </td>
  496. </tr>
  497. <tr>
  498. <td class="paramkey"></td>
  499. <td></td>
  500. <td class="paramtype">b&#160;</td>
  501. <td class="paramname">&#160;</td>
  502. </tr>
  503. <tr>
  504. <td></td>
  505. <td>)</td>
  506. <td></td><td></td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>Returns the Maximum of two values. </p>
  511. </div>
  512. </div>
  513. <a id="gad8cf7b1316e3eab55592adc8fa1edcbc" name="gad8cf7b1316e3eab55592adc8fa1edcbc"></a>
  514. <h2 class="memtitle"><span class="permalink"><a href="#gad8cf7b1316e3eab55592adc8fa1edcbc">&#9670;&#160;</a></span>mGetMin()</h2>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mGetMin </td>
  520. <td>(</td>
  521. <td class="paramtype">a&#160;</td>
  522. <td class="paramname">, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">b&#160;</td>
  528. <td class="paramname">&#160;</td>
  529. </tr>
  530. <tr>
  531. <td></td>
  532. <td>)</td>
  533. <td></td><td></td>
  534. </tr>
  535. </table>
  536. </div><div class="memdoc">
  537. <p>Returns the Minimum of two values. </p>
  538. </div>
  539. </div>
  540. <a id="ga7d80549c4e47c06c3bcb009c742ab367" name="ga7d80549c4e47c06c3bcb009c742ab367"></a>
  541. <h2 class="memtitle"><span class="permalink"><a href="#ga7d80549c4e47c06c3bcb009c742ab367">&#9670;&#160;</a></span>mLog()</h2>
  542. <div class="memitem">
  543. <div class="memproto">
  544. <table class="memname">
  545. <tr>
  546. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mLog </td>
  547. <td>(</td>
  548. <td class="paramtype">val&#160;</td>
  549. <td class="paramname"></td><td>)</td>
  550. <td></td>
  551. </tr>
  552. </table>
  553. </div><div class="memdoc">
  554. <p>Use the mLog function to calculate the natural logarithm of val. </p><dl class="params"><dt>Parameters</dt><dd>
  555. <table class="params">
  556. <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
  557. </table>
  558. </dd>
  559. </dl>
  560. <dl class="section return"><dt>Returns</dt><dd>Returns the natural logarithm of val </dd></dl>
  561. </div>
  562. </div>
  563. <a id="gaaf03cec597971519aa33dfc8de539ad4" name="gaaf03cec597971519aa33dfc8de539ad4"></a>
  564. <h2 class="memtitle"><span class="permalink"><a href="#gaaf03cec597971519aa33dfc8de539ad4">&#9670;&#160;</a></span>mPow()</h2>
  565. <div class="memitem">
  566. <div class="memproto">
  567. <table class="memname">
  568. <tr>
  569. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mPow </td>
  570. <td>(</td>
  571. <td class="paramtype">val&#160;</td>
  572. <td class="paramname">, </td>
  573. </tr>
  574. <tr>
  575. <td class="paramkey"></td>
  576. <td></td>
  577. <td class="paramtype">power&#160;</td>
  578. <td class="paramname">&#160;</td>
  579. </tr>
  580. <tr>
  581. <td></td>
  582. <td>)</td>
  583. <td></td><td></td>
  584. </tr>
  585. </table>
  586. </div><div class="memdoc">
  587. <p>Use the mPow function to calculated val raised to the power of power. </p><dl class="params"><dt>Parameters</dt><dd>
  588. <table class="params">
  589. <tr><td class="paramname">val</td><td>A numeric (integer or floating-point) value to be raised to a power. </td></tr>
  590. <tr><td class="paramname">power</td><td>A numeric (integer or floating-point) power to raise val to. </td></tr>
  591. </table>
  592. </dd>
  593. </dl>
  594. <dl class="section return"><dt>Returns</dt><dd>Returns val^power </dd></dl>
  595. </div>
  596. </div>
  597. <a id="ga1d996a02e1ddbc2328a7058cec119576" name="ga1d996a02e1ddbc2328a7058cec119576"></a>
  598. <h2 class="memtitle"><span class="permalink"><a href="#ga1d996a02e1ddbc2328a7058cec119576">&#9670;&#160;</a></span>mRadToDeg()</h2>
  599. <div class="memitem">
  600. <div class="memproto">
  601. <table class="memname">
  602. <tr>
  603. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mRadToDeg </td>
  604. <td>(</td>
  605. <td class="paramtype">val&#160;</td>
  606. <td class="paramname"></td><td>)</td>
  607. <td></td>
  608. </tr>
  609. </table>
  610. </div><div class="memdoc">
  611. <p>Use the mRadToDeg function to convert radians to degrees. </p><dl class="params"><dt>Parameters</dt><dd>
  612. <table class="params">
  613. <tr><td class="paramname">val</td><td>A floating-point number representing some number of radians. </td></tr>
  614. </table>
  615. </dd>
  616. </dl>
  617. <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the radian value val in degrees. </dd></dl>
  618. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gaf502c5c8f38d39a4027bfcdb54d4a573">mDegToRad</a> </dd></dl>
  619. </div>
  620. </div>
  621. <a id="gaa532d15c461ad665c6ca1f208f4edb99" name="gaa532d15c461ad665c6ca1f208f4edb99"></a>
  622. <h2 class="memtitle"><span class="permalink"><a href="#gaa532d15c461ad665c6ca1f208f4edb99">&#9670;&#160;</a></span>mRound()</h2>
  623. <div class="memitem">
  624. <div class="memproto">
  625. <table class="memname">
  626. <tr>
  627. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mRound </td>
  628. <td>(</td>
  629. <td class="paramtype">float&#160;</td>
  630. <td class="paramname"><em>v</em></td><td>)</td>
  631. <td></td>
  632. </tr>
  633. </table>
  634. </div><div class="memdoc">
  635. <p>Rounds a number. 0.5 is rounded up. </p><dl class="params"><dt>Parameters</dt><dd>
  636. <table class="params">
  637. <tr><td class="paramname">val</td><td>A floating-point value </td></tr>
  638. </table>
  639. </dd>
  640. </dl>
  641. <dl class="section return"><dt>Returns</dt><dd>Returns the integer value closest to the given float </dd></dl>
  642. </div>
  643. </div>
  644. <a id="gad4dee8264c82983c08d48ec494a6345a" name="gad4dee8264c82983c08d48ec494a6345a"></a>
  645. <h2 class="memtitle"><span class="permalink"><a href="#gad4dee8264c82983c08d48ec494a6345a">&#9670;&#160;</a></span>mSin()</h2>
  646. <div class="memitem">
  647. <div class="memproto">
  648. <table class="memname">
  649. <tr>
  650. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mSin </td>
  651. <td>(</td>
  652. <td class="paramtype">val&#160;</td>
  653. <td class="paramname"></td><td>)</td>
  654. <td></td>
  655. </tr>
  656. </table>
  657. </div><div class="memdoc">
  658. <p>Use the mSin function to get the sine of the angle val. </p><dl class="params"><dt>Parameters</dt><dd>
  659. <table class="params">
  660. <tr><td class="paramname">val</td><td>A value in degrees. </td></tr>
  661. </table>
  662. </dd>
  663. </dl>
  664. <dl class="section return"><dt>Returns</dt><dd>Returns the sine of val. This value will be in the range [ -1.0 , 1.0 ]. </dd></dl>
  665. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga220952eb9eac31d3adffd769b82672a3">mAsin</a> </dd></dl>
  666. </div>
  667. </div>
  668. <a id="ga0905f7ed2523c11ab28215969d34e8f9" name="ga0905f7ed2523c11ab28215969d34e8f9"></a>
  669. <h2 class="memtitle"><span class="permalink"><a href="#ga0905f7ed2523c11ab28215969d34e8f9">&#9670;&#160;</a></span>mSolveCubic()</h2>
  670. <div class="memitem">
  671. <div class="memproto">
  672. <table class="memname">
  673. <tr>
  674. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveCubic </td>
  675. <td>(</td>
  676. <td class="paramtype">float&#160;</td>
  677. <td class="paramname"><em>a</em>, </td>
  678. </tr>
  679. <tr>
  680. <td class="paramkey"></td>
  681. <td></td>
  682. <td class="paramtype">float&#160;</td>
  683. <td class="paramname"><em>b</em>, </td>
  684. </tr>
  685. <tr>
  686. <td class="paramkey"></td>
  687. <td></td>
  688. <td class="paramtype">float&#160;</td>
  689. <td class="paramname"><em>c</em>, </td>
  690. </tr>
  691. <tr>
  692. <td class="paramkey"></td>
  693. <td></td>
  694. <td class="paramtype">float&#160;</td>
  695. <td class="paramname"><em>d</em>&#160;</td>
  696. </tr>
  697. <tr>
  698. <td></td>
  699. <td>)</td>
  700. <td></td><td></td>
  701. </tr>
  702. </table>
  703. </div><div class="memdoc">
  704. <p>Solve a cubic equation of form a*x^3 + b*x^2 + c*x + d = 0. </p><dl class="section return"><dt>Returns</dt><dd>A 4-tuple, contanining: sol x0 x1 x2. sol is the number of solutions (being 0, 1, 2, or 3), and x0, x1, x2 are the solutions, if any. Unused x's are undefined. </dd></dl>
  705. </div>
  706. </div>
  707. <a id="ga76d1f6e842a6a9d50dedf4589739b422" name="ga76d1f6e842a6a9d50dedf4589739b422"></a>
  708. <h2 class="memtitle"><span class="permalink"><a href="#ga76d1f6e842a6a9d50dedf4589739b422">&#9670;&#160;</a></span>mSolveQuadratic()</h2>
  709. <div class="memitem">
  710. <div class="memproto">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveQuadratic </td>
  714. <td>(</td>
  715. <td class="paramtype">float&#160;</td>
  716. <td class="paramname"><em>a</em>, </td>
  717. </tr>
  718. <tr>
  719. <td class="paramkey"></td>
  720. <td></td>
  721. <td class="paramtype">float&#160;</td>
  722. <td class="paramname"><em>b</em>, </td>
  723. </tr>
  724. <tr>
  725. <td class="paramkey"></td>
  726. <td></td>
  727. <td class="paramtype">float&#160;</td>
  728. <td class="paramname"><em>c</em>&#160;</td>
  729. </tr>
  730. <tr>
  731. <td></td>
  732. <td>)</td>
  733. <td></td><td></td>
  734. </tr>
  735. </table>
  736. </div><div class="memdoc">
  737. <p>Solve a quadratic equation of form a*x^2 + b*x + c = 0. </p><dl class="section return"><dt>Returns</dt><dd>A triple, contanining: sol x0 x1. sol is the number of solutions (being 0, 1, or 2), and x0 and x1 are the solutions, if any. Unused x's are undefined. </dd></dl>
  738. </div>
  739. </div>
  740. <a id="ga9a6bd90dad704a305b65bfafd1872ead" name="ga9a6bd90dad704a305b65bfafd1872ead"></a>
  741. <h2 class="memtitle"><span class="permalink"><a href="#ga9a6bd90dad704a305b65bfafd1872ead">&#9670;&#160;</a></span>mSolveQuartic()</h2>
  742. <div class="memitem">
  743. <div class="memproto">
  744. <table class="memname">
  745. <tr>
  746. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveQuartic </td>
  747. <td>(</td>
  748. <td class="paramtype">float&#160;</td>
  749. <td class="paramname"><em>a</em>, </td>
  750. </tr>
  751. <tr>
  752. <td class="paramkey"></td>
  753. <td></td>
  754. <td class="paramtype">float&#160;</td>
  755. <td class="paramname"><em>b</em>, </td>
  756. </tr>
  757. <tr>
  758. <td class="paramkey"></td>
  759. <td></td>
  760. <td class="paramtype">float&#160;</td>
  761. <td class="paramname"><em>c</em>, </td>
  762. </tr>
  763. <tr>
  764. <td class="paramkey"></td>
  765. <td></td>
  766. <td class="paramtype">float&#160;</td>
  767. <td class="paramname"><em>d</em>, </td>
  768. </tr>
  769. <tr>
  770. <td class="paramkey"></td>
  771. <td></td>
  772. <td class="paramtype">float&#160;</td>
  773. <td class="paramname"><em>e</em>&#160;</td>
  774. </tr>
  775. <tr>
  776. <td></td>
  777. <td>)</td>
  778. <td></td><td></td>
  779. </tr>
  780. </table>
  781. </div><div class="memdoc">
  782. <p>Solve a quartic equation of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. </p><dl class="section return"><dt>Returns</dt><dd>A 5-tuple, contanining: sol x0 x1 x2 x3. sol is the number of solutions (ranging from 0-4), and x0, x1, x2 and x3 are the solutions, if any. Unused x's are undefined. </dd></dl>
  783. </div>
  784. </div>
  785. <a id="gaf1f8e9ea7921dec013f9e691df32b572" name="gaf1f8e9ea7921dec013f9e691df32b572"></a>
  786. <h2 class="memtitle"><span class="permalink"><a href="#gaf1f8e9ea7921dec013f9e691df32b572">&#9670;&#160;</a></span>mSqrt()</h2>
  787. <div class="memitem">
  788. <div class="memproto">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mSqrt </td>
  792. <td>(</td>
  793. <td class="paramtype">val&#160;</td>
  794. <td class="paramname"></td><td>)</td>
  795. <td></td>
  796. </tr>
  797. </table>
  798. </div><div class="memdoc">
  799. <p>Use the mSqrt function to calculated the square root of val. </p><dl class="params"><dt>Parameters</dt><dd>
  800. <table class="params">
  801. <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
  802. </table>
  803. </dd>
  804. </dl>
  805. <dl class="section return"><dt>Returns</dt><dd>Returns the the squareroot of val </dd></dl>
  806. </div>
  807. </div>
  808. <a id="ga0c29659486a06c868277811e71d55a75" name="ga0c29659486a06c868277811e71d55a75"></a>
  809. <h2 class="memtitle"><span class="permalink"><a href="#ga0c29659486a06c868277811e71d55a75">&#9670;&#160;</a></span>mTan()</h2>
  810. <div class="memitem">
  811. <div class="memproto">
  812. <table class="memname">
  813. <tr>
  814. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mTan </td>
  815. <td>(</td>
  816. <td class="paramtype">val&#160;</td>
  817. <td class="paramname"></td><td>)</td>
  818. <td></td>
  819. </tr>
  820. </table>
  821. </div><div class="memdoc">
  822. <p>Use the mTan function to get the tangent of the angle val. </p><dl class="params"><dt>Parameters</dt><dd>
  823. <table class="params">
  824. <tr><td class="paramname">val</td><td>A value in degrees. </td></tr>
  825. </table>
  826. </dd>
  827. </dl>
  828. <dl class="section return"><dt>Returns</dt><dd>Returns the tangent of val. This value will be in the range [ -inf.0 , inf.0 ]. </dd></dl>
  829. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gac7909662d8361784ac11b2343b9cb9cf">mAtan</a> </dd></dl>
  830. </div>
  831. </div>
  832. <a id="ga8a88d5cab721957271edb846e2cde879" name="ga8a88d5cab721957271edb846e2cde879"></a>
  833. <h2 class="memtitle"><span class="permalink"><a href="#ga8a88d5cab721957271edb846e2cde879">&#9670;&#160;</a></span>removeBitFromMask()</h2>
  834. <div class="memitem">
  835. <div class="memproto">
  836. <table class="memname">
  837. <tr>
  838. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> removeBitFromMask </td>
  839. <td>(</td>
  840. <td class="paramtype">mask&#160;</td>
  841. <td class="paramname">, </td>
  842. </tr>
  843. <tr>
  844. <td class="paramkey"></td>
  845. <td></td>
  846. <td class="paramtype"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>&#160;</td>
  847. <td class="paramname">&#160;</td>
  848. </tr>
  849. <tr>
  850. <td></td>
  851. <td>)</td>
  852. <td></td><td></td>
  853. </tr>
  854. </table>
  855. </div><div class="memdoc">
  856. <p>Returns the mask with a bit removed from it </p>
  857. </div>
  858. </div>
  859. </div><!-- contents -->
  860. <!-- start footer part -->
  861. <hr class="footer"/><address class="footer"><small>
  862. 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
  863. </small></address>
  864. </body>
  865. </html>