Home Explore Help
Sign In
TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 9aa0867d16
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
group__MathFunctions.html

group__MathFunctions.html 41 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
    7. 

  7. <title>TorqueScript Reference: Math (Non-Vector)</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    16. 

  16. <div id="titlearea">
    17. 

  17. <table cellspacing="0" cellpadding="0">
    18. 

  18.  <tbody>
    19. 

  19.  <tr style="height: 56px;">
    20. 

  20.   <td style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">TorqueScript Reference
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.3.1 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

  34.       <li><a href="modules.html"><span>Modules</span></a></li>
    35. 

  35.       <li><a href="annotated.html"><span>Classes</span></a></li>
    36. 

  36.     </ul>
    37. 

  37.   </div>
    38. 

  38. </div><!-- top -->
    39. 

  39. <div class="header">
    40. 

  40.   <div class="summary">
    41. 

  41. <a href="#func-members">Functions</a>  </div>
    42. 

  42.   <div class="headertitle">
    43. 

  43. <div class="title">Math (Non-Vector)<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div>  </div>
    44. 

  44. </div><!--header-->
    45. 

  45. <div class="contents">
    46. 

  46. <table class="memberdecls">
    47. 

  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    48. 

  48. Functions</h2></td></tr>
    49. 

  49. <tr class="memitem: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>
    50. 

  50. <tr class="separator:ga2106631b7788822a95367b32142999eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    51. 

  51. <tr class="memitem: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>
    52. 

  52. <tr class="separator:ga7763021eda6826df8311f3506707206e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. <tr class="memitem: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>
    54. 

  54. <tr class="separator:ga061a743f758efc28b3abfcda018ce5f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    55. 

  55. <tr class="memitem: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>
    56. 

  56. <tr class="separator:ga226a173fecd58ccc2b66e185111a23ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
    57. 

  57. <tr class="memitem: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>
    58. 

  58. <tr class="separator:gae3d373c8e4f47876e79580255fda09ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem: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>
    60. 

  60. <tr class="separator:gada34c6c74dfdcb11cbcfd8fa93723ae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    61. 

  61. <tr class="memitem: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>
    62. 

  62. <tr class="separator:ga220952eb9eac31d3adffd769b82672a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    63. 

  63. <tr class="memitem: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>
    64. 

  64. <tr class="separator:gac7909662d8361784ac11b2343b9cb9cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. <tr class="memitem: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>
    66. 

  66. <tr class="separator:ga0003814a0ab34f56c612bf415df188f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    67. 

  67. <tr class="memitem: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>
    68. 

  68. <tr class="separator:gad89b62df29c737c57d22c63a534817fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
    69. 

  69. <tr class="memitem: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>
    70. 

  70. <tr class="separator:ga57830e6b2dbe67572482a4b5484ff68a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    71. 

  71. <tr class="memitem: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>
    72. 

  72. <tr class="separator:gaf502c5c8f38d39a4027bfcdb54d4a573"><td class="memSeparator" colspan="2">&#160;</td></tr>
    73. 

  73. <tr class="memitem: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>
    74. 

  74. <tr class="separator:ga2d1f398ae7b17b53b522c761f4678b4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    75. 

  75. <tr class="memitem: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>
    76. 

  76. <tr class="separator:ga4212b2d30f340138e6472fe7224116d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    77. 

  77. <tr class="memitem: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>
    78. 

  78. <tr class="separator:ga27c1afd89a939bd1cc141b78cbbe3de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    79. 

  79. <tr class="memitem: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>
    80. 

  80. <tr class="separator:gad8cf7b1316e3eab55592adc8fa1edcbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    81. 

  81. <tr class="memitem: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>
    82. 

  82. <tr class="separator:ga7d80549c4e47c06c3bcb009c742ab367"><td class="memSeparator" colspan="2">&#160;</td></tr>
    83. 

  83. <tr class="memitem: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>
    84. 

  84. <tr class="separator:gaaf03cec597971519aa33dfc8de539ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    85. 

  85. <tr class="memitem: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>
    86. 

  86. <tr class="separator:ga1d996a02e1ddbc2328a7058cec119576"><td class="memSeparator" colspan="2">&#160;</td></tr>
    87. 

  87. <tr class="memitem: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>
    88. 

  88. <tr class="separator:gaa532d15c461ad665c6ca1f208f4edb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
    89. 

  89. <tr class="memitem: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>
    90. 

  90. <tr class="separator:gad4dee8264c82983c08d48ec494a6345a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    91. 

  91. <tr class="memitem: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>
    92. 

  92. <tr class="separator:ga0905f7ed2523c11ab28215969d34e8f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    93. 

  93. <tr class="memitem: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>
    94. 

  94. <tr class="separator:ga76d1f6e842a6a9d50dedf4589739b422"><td class="memSeparator" colspan="2">&#160;</td></tr>
    95. 

  95. <tr class="memitem: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>
    96. 

  96. <tr class="separator:ga9a6bd90dad704a305b65bfafd1872ead"><td class="memSeparator" colspan="2">&#160;</td></tr>
    97. 

  97. <tr class="memitem: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>
    98. 

  98. <tr class="separator:gaf1f8e9ea7921dec013f9e691df32b572"><td class="memSeparator" colspan="2">&#160;</td></tr>
    99. 

  99. <tr class="memitem: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>
    100. 

  100. <tr class="separator:ga0c29659486a06c868277811e71d55a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
    101. 

  101. <tr class="memitem: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>
    102. 

  102. <tr class="separator:ga8a88d5cab721957271edb846e2cde879"><td class="memSeparator" colspan="2">&#160;</td></tr>
    103. 

  103. </table>
    104. 

  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    105. 

  105. <h2 class="groupheader">Function Documentation</h2>
    106. 

  106. <a class="anchor" id="ga2106631b7788822a95367b32142999eb"></a>
    107. 

  107. <div class="memitem">
    108. 

  108. <div class="memproto">
    109. 

  109.       <table class="memname">
    110. 

  110.         <tr>
    111. 

  111.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> addBitToMask </td>
    112. 

  112.           <td>(</td>
    113. 

  113.           <td class="paramtype">mask&#160;</td>
    114. 

  114.           <td class="paramname">, </td>
    115. 

  115.         </tr>
    116. 

  116.         <tr>
    117. 

  117.           <td class="paramkey"></td>
    118. 

  118.           <td></td>
    119. 

  119.           <td class="paramtype"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>&#160;</td>
    120. 

  120.           <td class="paramname">&#160;</td>
    121. 

  121.         </tr>
    122. 

  122.         <tr>
    123. 

  123.           <td></td>
    124. 

  124.           <td>)</td>
    125. 

  125.           <td></td><td></td>
    126. 

  126.         </tr>
    127. 

  127.       </table>
    128. 

  128. </div><div class="memdoc">
    129. 

  129. <p>Returns the mask with a bit added to it </p>
    130. 

  130. 

  131. </div>
    132. 

  132. </div>
    133. 

  133. <a class="anchor" id="ga7763021eda6826df8311f3506707206e"></a>
    134. 

  134. <div class="memitem">
    135. 

  135. <div class="memproto">
    136. 

  136.       <table class="memname">
    137. 

  137.         <tr>
    138. 

  138.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bit </td>
    139. 

  139.           <td>(</td>
    140. 

  140.           <td class="paramname"></td><td>)</td>
    141. 

  141.           <td></td>
    142. 

  142.         </tr>
    143. 

  143.       </table>
    144. 

  144. </div><div class="memdoc">
    145. 

  145. <p>Converts a bit-position into a value. </p>
    146. 

  146. 

  147. </div>
    148. 

  148. </div>
    149. 

  149. <a class="anchor" id="ga061a743f758efc28b3abfcda018ce5f8"></a>
    150. 

  150. <div class="memitem">
    151. 

  151. <div class="memproto">
    152. 

  152.       <table class="memname">
    153. 

  153.         <tr>
    154. 

  154.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bitInverse </td>
    155. 

  155.           <td>(</td>
    156. 

  156.           <td class="paramname"></td><td>)</td>
    157. 

  157.           <td></td>
    158. 

  158.         </tr>
    159. 

  159.       </table>
    160. 

  160. </div><div class="memdoc">
    161. 

  161. <p>Returns the ones complement of a bit. </p>
    162. 

  162. 

  163. </div>
    164. 

  164. </div>
    165. 

  165. <a class="anchor" id="ga226a173fecd58ccc2b66e185111a23ef"></a>
    166. 

  166. <div class="memitem">
    167. 

  167. <div class="memproto">
    168. 

  168.       <table class="memname">
    169. 

  169.         <tr>
    170. 

  170.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bits </td>
    171. 

  171.           <td>(</td>
    172. 

  172.           <td class="paramname"></td><td>)</td>
    173. 

  173.           <td></td>
    174. 

  174.         </tr>
    175. 

  175.       </table>
    176. 

  176. </div><div class="memdoc">
    177. 

  177. <p>Converts a list of bit-positions into a value. </p>
    178. 

  178. 

  179. </div>
    180. 

  180. </div>
    181. 

  181. <a class="anchor" id="gae3d373c8e4f47876e79580255fda09ca"></a>
    182. 

  182. <div class="memitem">
    183. 

  183. <div class="memproto">
    184. 

  184.       <table class="memname">
    185. 

  185.         <tr>
    186. 

  186.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAbs </td>
    187. 

  187.           <td>(</td>
    188. 

  188.           <td class="paramtype">val&#160;</td>
    189. 

  189.           <td class="paramname"></td><td>)</td>
    190. 

  190.           <td></td>
    191. 

  191.         </tr>
    192. 

  192.       </table>
    193. 

  193. </div><div class="memdoc">
    194. 

  194. <p>Use the mAbs function to get the magnitude of val. </p>
    195. 

  195. <dl class="params"><dt>Parameters</dt><dd>
    196. 

  196.   <table class="params">
    197. 

  197.     <tr><td class="paramname">val</td><td>An integer or a floating-point value. </td></tr>
    198. 

  198.   </table>
    199. 

  199.   </dd>
    200. 

  200. </dl>
    201. 

  201. <dl class="section return"><dt>Returns</dt><dd>Returns the magnitude of val </dd></dl>
    202. 

  202. 

  203. </div>
    204. 

  204. </div>
    205. 

  205. <a class="anchor" id="gada34c6c74dfdcb11cbcfd8fa93723ae9"></a>
    206. 

  206. <div class="memitem">
    207. 

  207. <div class="memproto">
    208. 

  208.       <table class="memname">
    209. 

  209.         <tr>
    210. 

  210.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAcos </td>
    211. 

  211.           <td>(</td>
    212. 

  212.           <td class="paramtype">val&#160;</td>
    213. 

  213.           <td class="paramname"></td><td>)</td>
    214. 

  214.           <td></td>
    215. 

  215.         </tr>
    216. 

  216.       </table>
    217. 

  217. </div><div class="memdoc">
    218. 

  218. <p>Use the mAcos function to get the inverse cosine of val in radians. </p>
    219. 

  219. <dl class="params"><dt>Parameters</dt><dd>
    220. 

  220.   <table class="params">
    221. 

  221.     <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>
    222. 

  222.   </table>
    223. 

  223.   </dd>
    224. 

  224. </dl>
    225. 

  225. <dl class="section return"><dt>Returns</dt><dd>Returns the inverse cosine of val in radians. This value will be in the range [ 0 , 3.14159 ]. </dd></dl>
    226. 

  226. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga57830e6b2dbe67572482a4b5484ff68a">mCos</a> </dd></dl>
    227. 

  227. 

  228. </div>
    229. 

  229. </div>
    230. 

  230. <a class="anchor" id="ga220952eb9eac31d3adffd769b82672a3"></a>
    231. 

  231. <div class="memitem">
    232. 

  232. <div class="memproto">
    233. 

  233.       <table class="memname">
    234. 

  234.         <tr>
    235. 

  235.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAsin </td>
    236. 

  236.           <td>(</td>
    237. 

  237.           <td class="paramtype">val&#160;</td>
    238. 

  238.           <td class="paramname"></td><td>)</td>
    239. 

  239.           <td></td>
    240. 

  240.         </tr>
    241. 

  241.       </table>
    242. 

  242. </div><div class="memdoc">
    243. 

  243. <p>Use the mAsin function to get the inverse sine of val in radians. </p>
    244. 

  244. <dl class="params"><dt>Parameters</dt><dd>
    245. 

  245.   <table class="params">
    246. 

  246.     <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>
    247. 

  247.   </table>
    248. 

  248.   </dd>
    249. 

  249. </dl>
    250. 

  250. <dl class="section return"><dt>Returns</dt><dd>Returns the inverse sine of val in radians. This value will be in the range [ - 3.14159/2 , 3.14159/2 ]. </dd></dl>
    251. 

  251. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gad4dee8264c82983c08d48ec494a6345a">mSin</a> </dd></dl>
    252. 

  252. 

  253. </div>
    254. 

  254. </div>
    255. 

  255. <a class="anchor" id="gac7909662d8361784ac11b2343b9cb9cf"></a>
    256. 

  256. <div class="memitem">
    257. 

  257. <div class="memproto">
    258. 

  258.       <table class="memname">
    259. 

  259.         <tr>
    260. 

  260.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAtan </td>
    261. 

  261.           <td>(</td>
    262. 

  262.           <td class="paramtype">val&#160;</td>
    263. 

  263.           <td class="paramname"></td><td>)</td>
    264. 

  264.           <td></td>
    265. 

  265.         </tr>
    266. 

  266.       </table>
    267. 

  267. </div><div class="memdoc">
    268. 

  268. <p>Use the mAtan function to get the inverse tangent of rise/run in radians. </p>
    269. 

  269. <dl class="params"><dt>Parameters</dt><dd>
    270. 

  270.   <table class="params">
    271. 

  271.     <tr><td class="paramname">rise</td><td>Vertical component of a line. </td></tr>
    272. 

  272.     <tr><td class="paramname">run</td><td>Horizontal component of a line. </td></tr>
    273. 

  273.   </table>
    274. 

  274.   </dd>
    275. 

  275. </dl>
    276. 

  276. <dl class="section return"><dt>Returns</dt><dd>Returns the slope in radians (the arc-tangent) of a line with the given rise and run. </dd></dl>
    277. 

  277. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga0c29659486a06c868277811e71d55a75">mTan</a> </dd></dl>
    278. 

  278. 

  279. </div>
    280. 

  280. </div>
    281. 

  281. <a class="anchor" id="ga0003814a0ab34f56c612bf415df188f4"></a>
    282. 

  282. <div class="memitem">
    283. 

  283. <div class="memproto">
    284. 

  284.       <table class="memname">
    285. 

  285.         <tr>
    286. 

  286.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> mCeil </td>
    287. 

  287.           <td>(</td>
    288. 

  288.           <td class="paramtype">val&#160;</td>
    289. 

  289.           <td class="paramname"></td><td>)</td>
    290. 

  290.           <td></td>
    291. 

  291.         </tr>
    292. 

  292.       </table>
    293. 

  293. </div><div class="memdoc">
    294. 

  294. <p>Use the mCeil function to calculate the next highest integer value from val. </p>
    295. 

  295. <dl class="params"><dt>Parameters</dt><dd>
    296. 

  296.   <table class="params">
    297. 

  297.     <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
    298. 

  298.   </table>
    299. 

  299.   </dd>
    300. 

  300. </dl>
    301. 

  301. <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next highest integer from val. </dd></dl>
    302. 

  302. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga4212b2d30f340138e6472fe7224116d8">mFloor</a> </dd></dl>
    303. 

  303. 

  304. </div>
    305. 

  305. </div>
    306. 

  306. <a class="anchor" id="gad89b62df29c737c57d22c63a534817fe"></a>
    307. 

  307. <div class="memitem">
    308. 

  308. <div class="memproto">
    309. 

  309.       <table class="memname">
    310. 

  310.         <tr>
    311. 

  311.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mClamp </td>
    312. 

  312.           <td>(</td>
    313. 

  313.           <td class="paramtype">float&#160;</td>
    314. 

  314.           <td class="paramname"><em>number</em>, </td>
    315. 

  315.         </tr>
    316. 

  316.         <tr>
    317. 

  317.           <td class="paramkey"></td>
    318. 

  318.           <td></td>
    319. 

  319.           <td class="paramtype">float&#160;</td>
    320. 

  320.           <td class="paramname"><em>min</em>, </td>
    321. 

  321.         </tr>
    322. 

  322.         <tr>
    323. 

  323.           <td class="paramkey"></td>
    324. 

  324.           <td></td>
    325. 

  325.           <td class="paramtype">float&#160;</td>
    326. 

  326.           <td class="paramname"><em>max</em>&#160;</td>
    327. 

  327.         </tr>
    328. 

  328.         <tr>
    329. 

  329.           <td></td>
    330. 

  330.           <td>)</td>
    331. 

  331.           <td></td><td></td>
    332. 

  332.         </tr>
    333. 

  333.       </table>
    334. 

  334. </div><div class="memdoc">
    335. 

  335. <p>Clamp a value between two other values. </p>
    336. 

  336. <dl class="params"><dt>Parameters</dt><dd>
    337. 

  337.   <table class="params">
    338. 

  338.     <tr><td class="paramname">number</td><td>A float value representing the number to clamp </td></tr>
    339. 

  339.     <tr><td class="paramname">min</td><td>The lower bound </td></tr>
    340. 

  340.     <tr><td class="paramname">max</td><td>The upper bound </td></tr>
    341. 

  341.   </table>
    342. 

  342.   </dd>
    343. 

  343. </dl>
    344. 

  344. <dl class="section return"><dt>Returns</dt><dd>A float value the is within the given range </dd></dl>
    345. 

  345. 

  346. </div>
    347. 

  347. </div>
    348. 

  348. <a class="anchor" id="ga57830e6b2dbe67572482a4b5484ff68a"></a>
    349. 

  349. <div class="memitem">
    350. 

  350. <div class="memproto">
    351. 

  351.       <table class="memname">
    352. 

  352.         <tr>
    353. 

  353.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mCos </td>
    354. 

  354.           <td>(</td>
    355. 

  355.           <td class="paramtype">val&#160;</td>
    356. 

  356.           <td class="paramname"></td><td>)</td>
    357. 

  357.           <td></td>
    358. 

  358.         </tr>
    359. 

  359.       </table>
    360. 

  360. </div><div class="memdoc">
    361. 

  361. <p>Use the mCos function to get the cosine of the radian angle val. </p>
    362. 

  362. <dl class="params"><dt>Parameters</dt><dd>
    363. 

  363.   <table class="params">
    364. 

  364.     <tr><td class="paramname">val</td><td>A value between -3.14159 and 3.14159. </td></tr>
    365. 

  365.   </table>
    366. 

  366.   </dd>
    367. 

  367. </dl>
    368. 

  368. <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>
    369. 

  369. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gada34c6c74dfdcb11cbcfd8fa93723ae9">mAcos</a> </dd></dl>
    370. 

  370. 

  371. </div>
    372. 

  372. </div>
    373. 

  373. <a class="anchor" id="gaf502c5c8f38d39a4027bfcdb54d4a573"></a>
    374. 

  374. <div class="memitem">
    375. 

  375. <div class="memproto">
    376. 

  376.       <table class="memname">
    377. 

  377.         <tr>
    378. 

  378.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mDegToRad </td>
    379. 

  379.           <td>(</td>
    380. 

  380.           <td class="paramtype">val&#160;</td>
    381. 

  381.           <td class="paramname"></td><td>)</td>
    382. 

  382.           <td></td>
    383. 

  383.         </tr>
    384. 

  384.       </table>
    385. 

  385. </div><div class="memdoc">
    386. 

  386. <p>Use the mDegToRad function to convert degrees to radians. </p>
    387. 

  387. <dl class="params"><dt>Parameters</dt><dd>
    388. 

  388.   <table class="params">
    389. 

  389.     <tr><td class="paramname">val</td><td>A floating-point number representing some number of degrees. </td></tr>
    390. 

  390.   </table>
    391. 

  391.   </dd>
    392. 

  392. </dl>
    393. 

  393. <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the degree value val in radians. </dd></dl>
    394. 

  394. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga1d996a02e1ddbc2328a7058cec119576">mRadToDeg</a> </dd></dl>
    395. 

  395. 

  396. </div>
    397. 

  397. </div>
    398. 

  398. <a class="anchor" id="ga2d1f398ae7b17b53b522c761f4678b4d"></a>
    399. 

  399. <div class="memitem">
    400. 

  400. <div class="memproto">
    401. 

  401.       <table class="memname">
    402. 

  402.         <tr>
    403. 

  403.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mFloatLength </td>
    404. 

  404.           <td>(</td>
    405. 

  405.           <td class="paramtype">val&#160;</td>
    406. 

  406.           <td class="paramname">, </td>
    407. 

  407.         </tr>
    408. 

  408.         <tr>
    409. 

  409.           <td class="paramkey"></td>
    410. 

  410.           <td></td>
    411. 

  411.           <td class="paramtype">numDecimals&#160;</td>
    412. 

  412.           <td class="paramname">&#160;</td>
    413. 

  413.         </tr>
    414. 

  414.         <tr>
    415. 

  415.           <td></td>
    416. 

  416.           <td>)</td>
    417. 

  417.           <td></td><td></td>
    418. 

  418.         </tr>
    419. 

  419.       </table>
    420. 

  420. </div><div class="memdoc">
    421. 

  421. <p>Use the mFloatLength function to limit the number of decimal places in val to numDecimals. </p>
    422. 

  422. <dl class="params"><dt>Parameters</dt><dd>
    423. 

  423.   <table class="params">
    424. 

  424.     <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
    425. 

  425.     <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>
    426. 

  426.   </table>
    427. 

  427.   </dd>
    428. 

  428. </dl>
    429. 

  429. <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>
    430. 

  430. 

  431. </div>
    432. 

  432. </div>
    433. 

  433. <a class="anchor" id="ga4212b2d30f340138e6472fe7224116d8"></a>
    434. 

  434. <div class="memitem">
    435. 

  435. <div class="memproto">
    436. 

  436.       <table class="memname">
    437. 

  437.         <tr>
    438. 

  438.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> mFloor </td>
    439. 

  439.           <td>(</td>
    440. 

  440.           <td class="paramtype">val&#160;</td>
    441. 

  441.           <td class="paramname"></td><td>)</td>
    442. 

  442.           <td></td>
    443. 

  443.         </tr>
    444. 

  444.       </table>
    445. 

  445. </div><div class="memdoc">
    446. 

  446. <p>Use the mFloor function to calculate the next lowest integer value from val. </p>
    447. 

  447. <dl class="params"><dt>Parameters</dt><dd>
    448. 

  448.   <table class="params">
    449. 

  449.     <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
    450. 

  450.   </table>
    451. 

  451.   </dd>
    452. 

  452. </dl>
    453. 

  453. <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next lowest integer from val. </dd></dl>
    454. 

  454. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga0003814a0ab34f56c612bf415df188f4">mCeil</a> </dd></dl>
    455. 

  455. 

  456. </div>
    457. 

  457. </div>
    458. 

  458. <a class="anchor" id="ga27c1afd89a939bd1cc141b78cbbe3de1"></a>
    459. 

  459. <div class="memitem">
    460. 

  460. <div class="memproto">
    461. 

  461.       <table class="memname">
    462. 

  462.         <tr>
    463. 

  463.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mGetMax </td>
    464. 

  464.           <td>(</td>
    465. 

  465.           <td class="paramtype">a&#160;</td>
    466. 

  466.           <td class="paramname">, </td>
    467. 

  467.         </tr>
    468. 

  468.         <tr>
    469. 

  469.           <td class="paramkey"></td>
    470. 

  470.           <td></td>
    471. 

  471.           <td class="paramtype">b&#160;</td>
    472. 

  472.           <td class="paramname">&#160;</td>
    473. 

  473.         </tr>
    474. 

  474.         <tr>
    475. 

  475.           <td></td>
    476. 

  476.           <td>)</td>
    477. 

  477.           <td></td><td></td>
    478. 

  478.         </tr>
    479. 

  479.       </table>
    480. 

  480. </div><div class="memdoc">
    481. 

  481. <p>Returns the Maximum of two values. </p>
    482. 

  482. 

  483. </div>
    484. 

  484. </div>
    485. 

  485. <a class="anchor" id="gad8cf7b1316e3eab55592adc8fa1edcbc"></a>
    486. 

  486. <div class="memitem">
    487. 

  487. <div class="memproto">
    488. 

  488.       <table class="memname">
    489. 

  489.         <tr>
    490. 

  490.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mGetMin </td>
    491. 

  491.           <td>(</td>
    492. 

  492.           <td class="paramtype">a&#160;</td>
    493. 

  493.           <td class="paramname">, </td>
    494. 

  494.         </tr>
    495. 

  495.         <tr>
    496. 

  496.           <td class="paramkey"></td>
    497. 

  497.           <td></td>
    498. 

  498.           <td class="paramtype">b&#160;</td>
    499. 

  499.           <td class="paramname">&#160;</td>
    500. 

  500.         </tr>
    501. 

  501.         <tr>
    502. 

  502.           <td></td>
    503. 

  503.           <td>)</td>
    504. 

  504.           <td></td><td></td>
    505. 

  505.         </tr>
    506. 

  506.       </table>
    507. 

  507. </div><div class="memdoc">
    508. 

  508. <p>Returns the Minimum of two values. </p>
    509. 

  509. 

  510. </div>
    511. 

  511. </div>
    512. 

  512. <a class="anchor" id="ga7d80549c4e47c06c3bcb009c742ab367"></a>
    513. 

  513. <div class="memitem">
    514. 

  514. <div class="memproto">
    515. 

  515.       <table class="memname">
    516. 

  516.         <tr>
    517. 

  517.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mLog </td>
    518. 

  518.           <td>(</td>
    519. 

  519.           <td class="paramtype">val&#160;</td>
    520. 

  520.           <td class="paramname"></td><td>)</td>
    521. 

  521.           <td></td>
    522. 

  522.         </tr>
    523. 

  523.       </table>
    524. 

  524. </div><div class="memdoc">
    525. 

  525. <p>Use the mLog function to calculate the natural logarithm of val. </p>
    526. 

  526. <dl class="params"><dt>Parameters</dt><dd>
    527. 

  527.   <table class="params">
    528. 

  528.     <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
    529. 

  529.   </table>
    530. 

  530.   </dd>
    531. 

  531. </dl>
    532. 

  532. <dl class="section return"><dt>Returns</dt><dd>Returns the natural logarithm of val </dd></dl>
    533. 

  533. 

  534. </div>
    535. 

  535. </div>
    536. 

  536. <a class="anchor" id="gaaf03cec597971519aa33dfc8de539ad4"></a>
    537. 

  537. <div class="memitem">
    538. 

  538. <div class="memproto">
    539. 

  539.       <table class="memname">
    540. 

  540.         <tr>
    541. 

  541.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mPow </td>
    542. 

  542.           <td>(</td>
    543. 

  543.           <td class="paramtype">val&#160;</td>
    544. 

  544.           <td class="paramname">, </td>
    545. 

  545.         </tr>
    546. 

  546.         <tr>
    547. 

  547.           <td class="paramkey"></td>
    548. 

  548.           <td></td>
    549. 

  549.           <td class="paramtype">power&#160;</td>
    550. 

  550.           <td class="paramname">&#160;</td>
    551. 

  551.         </tr>
    552. 

  552.         <tr>
    553. 

  553.           <td></td>
    554. 

  554.           <td>)</td>
    555. 

  555.           <td></td><td></td>
    556. 

  556.         </tr>
    557. 

  557.       </table>
    558. 

  558. </div><div class="memdoc">
    559. 

  559. <p>Use the mPow function to calculated val raised to the power of power. </p>
    560. 

  560. <dl class="params"><dt>Parameters</dt><dd>
    561. 

  561.   <table class="params">
    562. 

  562.     <tr><td class="paramname">val</td><td>A numeric (integer or floating-point) value to be raised to a power. </td></tr>
    563. 

  563.     <tr><td class="paramname">power</td><td>A numeric (integer or floating-point) power to raise val to. </td></tr>
    564. 

  564.   </table>
    565. 

  565.   </dd>
    566. 

  566. </dl>
    567. 

  567. <dl class="section return"><dt>Returns</dt><dd>Returns val^power </dd></dl>
    568. 

  568. 

  569. </div>
    570. 

  570. </div>
    571. 

  571. <a class="anchor" id="ga1d996a02e1ddbc2328a7058cec119576"></a>
    572. 

  572. <div class="memitem">
    573. 

  573. <div class="memproto">
    574. 

  574.       <table class="memname">
    575. 

  575.         <tr>
    576. 

  576.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mRadToDeg </td>
    577. 

  577.           <td>(</td>
    578. 

  578.           <td class="paramtype">val&#160;</td>
    579. 

  579.           <td class="paramname"></td><td>)</td>
    580. 

  580.           <td></td>
    581. 

  581.         </tr>
    582. 

  582.       </table>
    583. 

  583. </div><div class="memdoc">
    584. 

  584. <p>Use the mRadToDeg function to convert radians to degrees. </p>
    585. 

  585. <dl class="params"><dt>Parameters</dt><dd>
    586. 

  586.   <table class="params">
    587. 

  587.     <tr><td class="paramname">val</td><td>A floating-point number representing some number of radians. </td></tr>
    588. 

  588.   </table>
    589. 

  589.   </dd>
    590. 

  590. </dl>
    591. 

  591. <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the radian value val in degrees. </dd></dl>
    592. 

  592. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gaf502c5c8f38d39a4027bfcdb54d4a573">mDegToRad</a> </dd></dl>
    593. 

  593. 

  594. </div>
    595. 

  595. </div>
    596. 

  596. <a class="anchor" id="gaa532d15c461ad665c6ca1f208f4edb99"></a>
    597. 

  597. <div class="memitem">
    598. 

  598. <div class="memproto">
    599. 

  599.       <table class="memname">
    600. 

  600.         <tr>
    601. 

  601.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mRound </td>
    602. 

  602.           <td>(</td>
    603. 

  603.           <td class="paramtype">float&#160;</td>
    604. 

  604.           <td class="paramname"><em>v</em></td><td>)</td>
    605. 

  605.           <td></td>
    606. 

  606.         </tr>
    607. 

  607.       </table>
    608. 

  608. </div><div class="memdoc">
    609. 

  609. <p>Rounds a number. 0.5 is rounded up. </p>
    610. 

  610. <dl class="params"><dt>Parameters</dt><dd>
    611. 

  611.   <table class="params">
    612. 

  612.     <tr><td class="paramname">val</td><td>A floating-point value </td></tr>
    613. 

  613.   </table>
    614. 

  614.   </dd>
    615. 

  615. </dl>
    616. 

  616. <dl class="section return"><dt>Returns</dt><dd>Returns the integer value closest to the given float </dd></dl>
    617. 

  617. 

  618. </div>
    619. 

  619. </div>
    620. 

  620. <a class="anchor" id="gad4dee8264c82983c08d48ec494a6345a"></a>
    621. 

  621. <div class="memitem">
    622. 

  622. <div class="memproto">
    623. 

  623.       <table class="memname">
    624. 

  624.         <tr>
    625. 

  625.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mSin </td>
    626. 

  626.           <td>(</td>
    627. 

  627.           <td class="paramtype">val&#160;</td>
    628. 

  628.           <td class="paramname"></td><td>)</td>
    629. 

  629.           <td></td>
    630. 

  630.         </tr>
    631. 

  631.       </table>
    632. 

  632. </div><div class="memdoc">
    633. 

  633. <p>Use the mSin function to get the sine of the radian angle val. </p>
    634. 

  634. <dl class="params"><dt>Parameters</dt><dd>
    635. 

  635.   <table class="params">
    636. 

  636.     <tr><td class="paramname">val</td><td>A value between -3.14159 and 3.14159. </td></tr>
    637. 

  637.   </table>
    638. 

  638.   </dd>
    639. 

  639. </dl>
    640. 

  640. <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>
    641. 

  641. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga220952eb9eac31d3adffd769b82672a3">mAsin</a> </dd></dl>
    642. 

  642. 

  643. </div>
    644. 

  644. </div>
    645. 

  645. <a class="anchor" id="ga0905f7ed2523c11ab28215969d34e8f9"></a>
    646. 

  646. <div class="memitem">
    647. 

  647. <div class="memproto">
    648. 

  648.       <table class="memname">
    649. 

  649.         <tr>
    650. 

  650.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveCubic </td>
    651. 

  651.           <td>(</td>
    652. 

  652.           <td class="paramtype">float&#160;</td>
    653. 

  653.           <td class="paramname"><em>a</em>, </td>
    654. 

  654.         </tr>
    655. 

  655.         <tr>
    656. 

  656.           <td class="paramkey"></td>
    657. 

  657.           <td></td>
    658. 

  658.           <td class="paramtype">float&#160;</td>
    659. 

  659.           <td class="paramname"><em>b</em>, </td>
    660. 

  660.         </tr>
    661. 

  661.         <tr>
    662. 

  662.           <td class="paramkey"></td>
    663. 

  663.           <td></td>
    664. 

  664.           <td class="paramtype">float&#160;</td>
    665. 

  665.           <td class="paramname"><em>c</em>, </td>
    666. 

  666.         </tr>
    667. 

  667.         <tr>
    668. 

  668.           <td class="paramkey"></td>
    669. 

  669.           <td></td>
    670. 

  670.           <td class="paramtype">float&#160;</td>
    671. 

  671.           <td class="paramname"><em>d</em>&#160;</td>
    672. 

  672.         </tr>
    673. 

  673.         <tr>
    674. 

  674.           <td></td>
    675. 

  675.           <td>)</td>
    676. 

  676.           <td></td><td></td>
    677. 

  677.         </tr>
    678. 

  678.       </table>
    679. 

  679. </div><div class="memdoc">
    680. 

  680. <p>Solve a cubic equation of form a*x^3 + b*x^2 + c*x + d = 0. </p>
    681. 

  681. <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>
    682. 

  682. 

  683. </div>
    684. 

  684. </div>
    685. 

  685. <a class="anchor" id="ga76d1f6e842a6a9d50dedf4589739b422"></a>
    686. 

  686. <div class="memitem">
    687. 

  687. <div class="memproto">
    688. 

  688.       <table class="memname">
    689. 

  689.         <tr>
    690. 

  690.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveQuadratic </td>
    691. 

  691.           <td>(</td>
    692. 

  692.           <td class="paramtype">float&#160;</td>
    693. 

  693.           <td class="paramname"><em>a</em>, </td>
    694. 

  694.         </tr>
    695. 

  695.         <tr>
    696. 

  696.           <td class="paramkey"></td>
    697. 

  697.           <td></td>
    698. 

  698.           <td class="paramtype">float&#160;</td>
    699. 

  699.           <td class="paramname"><em>b</em>, </td>
    700. 

  700.         </tr>
    701. 

  701.         <tr>
    702. 

  702.           <td class="paramkey"></td>
    703. 

  703.           <td></td>
    704. 

  704.           <td class="paramtype">float&#160;</td>
    705. 

  705.           <td class="paramname"><em>c</em>&#160;</td>
    706. 

  706.         </tr>
    707. 

  707.         <tr>
    708. 

  708.           <td></td>
    709. 

  709.           <td>)</td>
    710. 

  710.           <td></td><td></td>
    711. 

  711.         </tr>
    712. 

  712.       </table>
    713. 

  713. </div><div class="memdoc">
    714. 

  714. <p>Solve a quadratic equation of form a*x^2 + b*x + c = 0. </p>
    715. 

  715. <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>
    716. 

  716. 

  717. </div>
    718. 

  718. </div>
    719. 

  719. <a class="anchor" id="ga9a6bd90dad704a305b65bfafd1872ead"></a>
    720. 

  720. <div class="memitem">
    721. 

  721. <div class="memproto">
    722. 

  722.       <table class="memname">
    723. 

  723.         <tr>
    724. 

  724.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveQuartic </td>
    725. 

  725.           <td>(</td>
    726. 

  726.           <td class="paramtype">float&#160;</td>
    727. 

  727.           <td class="paramname"><em>a</em>, </td>
    728. 

  728.         </tr>
    729. 

  729.         <tr>
    730. 

  730.           <td class="paramkey"></td>
    731. 

  731.           <td></td>
    732. 

  732.           <td class="paramtype">float&#160;</td>
    733. 

  733.           <td class="paramname"><em>b</em>, </td>
    734. 

  734.         </tr>
    735. 

  735.         <tr>
    736. 

  736.           <td class="paramkey"></td>
    737. 

  737.           <td></td>
    738. 

  738.           <td class="paramtype">float&#160;</td>
    739. 

  739.           <td class="paramname"><em>c</em>, </td>
    740. 

  740.         </tr>
    741. 

  741.         <tr>
    742. 

  742.           <td class="paramkey"></td>
    743. 

  743.           <td></td>
    744. 

  744.           <td class="paramtype">float&#160;</td>
    745. 

  745.           <td class="paramname"><em>d</em>, </td>
    746. 

  746.         </tr>
    747. 

  747.         <tr>
    748. 

  748.           <td class="paramkey"></td>
    749. 

  749.           <td></td>
    750. 

  750.           <td class="paramtype">float&#160;</td>
    751. 

  751.           <td class="paramname"><em>e</em>&#160;</td>
    752. 

  752.         </tr>
    753. 

  753.         <tr>
    754. 

  754.           <td></td>
    755. 

  755.           <td>)</td>
    756. 

  756.           <td></td><td></td>
    757. 

  757.         </tr>
    758. 

  758.       </table>
    759. 

  759. </div><div class="memdoc">
    760. 

  760. <p>Solve a quartic equation of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. </p>
    761. 

  761. <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>
    762. 

  762. 

  763. </div>
    764. 

  764. </div>
    765. 

  765. <a class="anchor" id="gaf1f8e9ea7921dec013f9e691df32b572"></a>
    766. 

  766. <div class="memitem">
    767. 

  767. <div class="memproto">
    768. 

  768.       <table class="memname">
    769. 

  769.         <tr>
    770. 

  770.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mSqrt </td>
    771. 

  771.           <td>(</td>
    772. 

  772.           <td class="paramtype">val&#160;</td>
    773. 

  773.           <td class="paramname"></td><td>)</td>
    774. 

  774.           <td></td>
    775. 

  775.         </tr>
    776. 

  776.       </table>
    777. 

  777. </div><div class="memdoc">
    778. 

  778. <p>Use the mSqrt function to calculated the square root of val. </p>
    779. 

  779. <dl class="params"><dt>Parameters</dt><dd>
    780. 

  780.   <table class="params">
    781. 

  781.     <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
    782. 

  782.   </table>
    783. 

  783.   </dd>
    784. 

  784. </dl>
    785. 

  785. <dl class="section return"><dt>Returns</dt><dd>Returns the the squareroot of val </dd></dl>
    786. 

  786. 

  787. </div>
    788. 

  788. </div>
    789. 

  789. <a class="anchor" id="ga0c29659486a06c868277811e71d55a75"></a>
    790. 

  790. <div class="memitem">
    791. 

  791. <div class="memproto">
    792. 

  792.       <table class="memname">
    793. 

  793.         <tr>
    794. 

  794.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mTan </td>
    795. 

  795.           <td>(</td>
    796. 

  796.           <td class="paramtype">val&#160;</td>
    797. 

  797.           <td class="paramname"></td><td>)</td>
    798. 

  798.           <td></td>
    799. 

  799.         </tr>
    800. 

  800.       </table>
    801. 

  801. </div><div class="memdoc">
    802. 

  802. <p>Use the mTan function to get the tangent of the radian angle val. </p>
    803. 

  803. <dl class="params"><dt>Parameters</dt><dd>
    804. 

  804.   <table class="params">
    805. 

  805.     <tr><td class="paramname">val</td><td>A value between -3.14159/2 and 3.14159/2. </td></tr>
    806. 

  806.   </table>
    807. 

  807.   </dd>
    808. 

  808. </dl>
    809. 

  809. <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>
    810. 

  810. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gac7909662d8361784ac11b2343b9cb9cf">mAtan</a> </dd></dl>
    811. 

  811. 

  812. </div>
    813. 

  813. </div>
    814. 

  814. <a class="anchor" id="ga8a88d5cab721957271edb846e2cde879"></a>
    815. 

  815. <div class="memitem">
    816. 

  816. <div class="memproto">
    817. 

  817.       <table class="memname">
    818. 

  818.         <tr>
    819. 

  819.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> removeBitFromMask </td>
    820. 

  820.           <td>(</td>
    821. 

  821.           <td class="paramtype">mask&#160;</td>
    822. 

  822.           <td class="paramname">, </td>
    823. 

  823.         </tr>
    824. 

  824.         <tr>
    825. 

  825.           <td class="paramkey"></td>
    826. 

  826.           <td></td>
    827. 

  827.           <td class="paramtype"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>&#160;</td>
    828. 

  828.           <td class="paramname">&#160;</td>
    829. 

  829.         </tr>
    830. 

  830.         <tr>
    831. 

  831.           <td></td>
    832. 

  832.           <td>)</td>
    833. 

  833.           <td></td><td></td>
    834. 

  834.         </tr>
    835. 

  835.       </table>
    836. 

  836. </div><div class="memdoc">
    837. 

  837. <p>Returns the mask with a bit removed from it </p>
    838. 

  838. 

  839. </div>
    840. 

  840. </div>
    841. 

  841. </div><!-- contents -->
    842. 

  842. <!-- start footer part -->
    843. 

  843. <hr class="footer"/><address class="footer"><small>
    844. 

  844. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    845. 

  845. <img class="footer" src="doxygen.png" alt="doxygen"/>
    846. 

  846. </a> 1.8.3.1
    847. 

  847. </small></address>
    848. 

  848. </body>
    849. 

  849. </html>
    850.