| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>TorqueScript Reference: Math (Non-Vector)</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <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>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga2106631b7788822a95367b32142999eb" id="r_ga2106631b7788822a95367b32142999eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga2106631b7788822a95367b32142999eb">addBitToMask</a> (mask, <a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>)</td></tr>
- <tr class="separator:ga2106631b7788822a95367b32142999eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7763021eda6826df8311f3506707206e" id="r_ga7763021eda6826df8311f3506707206e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a> ()</td></tr>
- <tr class="separator:ga7763021eda6826df8311f3506707206e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga061a743f758efc28b3abfcda018ce5f8" id="r_ga061a743f758efc28b3abfcda018ce5f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga061a743f758efc28b3abfcda018ce5f8">bitInverse</a> ()</td></tr>
- <tr class="separator:ga061a743f758efc28b3abfcda018ce5f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga226a173fecd58ccc2b66e185111a23ef" id="r_ga226a173fecd58ccc2b66e185111a23ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga226a173fecd58ccc2b66e185111a23ef">bits</a> ()</td></tr>
- <tr class="separator:ga226a173fecd58ccc2b66e185111a23ef"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae3d373c8e4f47876e79580255fda09ca" id="r_gae3d373c8e4f47876e79580255fda09ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gae3d373c8e4f47876e79580255fda09ca">mAbs</a> (val)</td></tr>
- <tr class="separator:gae3d373c8e4f47876e79580255fda09ca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gada34c6c74dfdcb11cbcfd8fa93723ae9" id="r_gada34c6c74dfdcb11cbcfd8fa93723ae9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gada34c6c74dfdcb11cbcfd8fa93723ae9">mAcos</a> (val)</td></tr>
- <tr class="separator:gada34c6c74dfdcb11cbcfd8fa93723ae9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga220952eb9eac31d3adffd769b82672a3" id="r_ga220952eb9eac31d3adffd769b82672a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga220952eb9eac31d3adffd769b82672a3">mAsin</a> (val)</td></tr>
- <tr class="separator:ga220952eb9eac31d3adffd769b82672a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac7909662d8361784ac11b2343b9cb9cf" id="r_gac7909662d8361784ac11b2343b9cb9cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gac7909662d8361784ac11b2343b9cb9cf">mAtan</a> (val)</td></tr>
- <tr class="separator:gac7909662d8361784ac11b2343b9cb9cf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0003814a0ab34f56c612bf415df188f4" id="r_ga0003814a0ab34f56c612bf415df188f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga0003814a0ab34f56c612bf415df188f4">mCeil</a> (val)</td></tr>
- <tr class="separator:ga0003814a0ab34f56c612bf415df188f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad89b62df29c737c57d22c63a534817fe" id="r_gad89b62df29c737c57d22c63a534817fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad89b62df29c737c57d22c63a534817fe">mClamp</a> (float number, float min, float max)</td></tr>
- <tr class="separator:gad89b62df29c737c57d22c63a534817fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga57830e6b2dbe67572482a4b5484ff68a" id="r_ga57830e6b2dbe67572482a4b5484ff68a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga57830e6b2dbe67572482a4b5484ff68a">mCos</a> (val)</td></tr>
- <tr class="separator:ga57830e6b2dbe67572482a4b5484ff68a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf502c5c8f38d39a4027bfcdb54d4a573" id="r_gaf502c5c8f38d39a4027bfcdb54d4a573"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf502c5c8f38d39a4027bfcdb54d4a573">mDegToRad</a> (val)</td></tr>
- <tr class="separator:gaf502c5c8f38d39a4027bfcdb54d4a573"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga10f33dc8c25d218ff0184fc9349d7fee" id="r_ga10f33dc8c25d218ff0184fc9349d7fee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga10f33dc8c25d218ff0184fc9349d7fee">mEase</a> (easeFunction, progress)</td></tr>
- <tr class="separator:ga10f33dc8c25d218ff0184fc9349d7fee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2d1f398ae7b17b53b522c761f4678b4d" id="r_ga2d1f398ae7b17b53b522c761f4678b4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga2d1f398ae7b17b53b522c761f4678b4d">mFloatLength</a> (val, numDecimals)</td></tr>
- <tr class="separator:ga2d1f398ae7b17b53b522c761f4678b4d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4212b2d30f340138e6472fe7224116d8" id="r_ga4212b2d30f340138e6472fe7224116d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga4212b2d30f340138e6472fe7224116d8">mFloor</a> (val)</td></tr>
- <tr class="separator:ga4212b2d30f340138e6472fe7224116d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga27c1afd89a939bd1cc141b78cbbe3de1" id="r_ga27c1afd89a939bd1cc141b78cbbe3de1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga27c1afd89a939bd1cc141b78cbbe3de1">mGetMax</a> (a, b)</td></tr>
- <tr class="separator:ga27c1afd89a939bd1cc141b78cbbe3de1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad8cf7b1316e3eab55592adc8fa1edcbc" id="r_gad8cf7b1316e3eab55592adc8fa1edcbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad8cf7b1316e3eab55592adc8fa1edcbc">mGetMin</a> (a, b)</td></tr>
- <tr class="separator:gad8cf7b1316e3eab55592adc8fa1edcbc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7d80549c4e47c06c3bcb009c742ab367" id="r_ga7d80549c4e47c06c3bcb009c742ab367"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga7d80549c4e47c06c3bcb009c742ab367">mLog</a> (val)</td></tr>
- <tr class="separator:ga7d80549c4e47c06c3bcb009c742ab367"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaaf03cec597971519aa33dfc8de539ad4" id="r_gaaf03cec597971519aa33dfc8de539ad4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaaf03cec597971519aa33dfc8de539ad4">mPow</a> (val, power)</td></tr>
- <tr class="separator:gaaf03cec597971519aa33dfc8de539ad4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1d996a02e1ddbc2328a7058cec119576" id="r_ga1d996a02e1ddbc2328a7058cec119576"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga1d996a02e1ddbc2328a7058cec119576">mRadToDeg</a> (val)</td></tr>
- <tr class="separator:ga1d996a02e1ddbc2328a7058cec119576"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa532d15c461ad665c6ca1f208f4edb99" id="r_gaa532d15c461ad665c6ca1f208f4edb99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaa532d15c461ad665c6ca1f208f4edb99">mRound</a> (float v)</td></tr>
- <tr class="separator:gaa532d15c461ad665c6ca1f208f4edb99"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad4dee8264c82983c08d48ec494a6345a" id="r_gad4dee8264c82983c08d48ec494a6345a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad4dee8264c82983c08d48ec494a6345a">mSin</a> (val)</td></tr>
- <tr class="separator:gad4dee8264c82983c08d48ec494a6345a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0905f7ed2523c11ab28215969d34e8f9" id="r_ga0905f7ed2523c11ab28215969d34e8f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga0905f7ed2523c11ab28215969d34e8f9">mSolveCubic</a> (float a, float b, float c, float d)</td></tr>
- <tr class="separator:ga0905f7ed2523c11ab28215969d34e8f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga76d1f6e842a6a9d50dedf4589739b422" id="r_ga76d1f6e842a6a9d50dedf4589739b422"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga76d1f6e842a6a9d50dedf4589739b422">mSolveQuadratic</a> (float a, float b, float c)</td></tr>
- <tr class="separator:ga76d1f6e842a6a9d50dedf4589739b422"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9a6bd90dad704a305b65bfafd1872ead" id="r_ga9a6bd90dad704a305b65bfafd1872ead"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga9a6bd90dad704a305b65bfafd1872ead">mSolveQuartic</a> (float a, float b, float c, float d, float e)</td></tr>
- <tr class="separator:ga9a6bd90dad704a305b65bfafd1872ead"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf1f8e9ea7921dec013f9e691df32b572" id="r_gaf1f8e9ea7921dec013f9e691df32b572"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf1f8e9ea7921dec013f9e691df32b572">mSqrt</a> (val)</td></tr>
- <tr class="separator:gaf1f8e9ea7921dec013f9e691df32b572"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0c29659486a06c868277811e71d55a75" id="r_ga0c29659486a06c868277811e71d55a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga0c29659486a06c868277811e71d55a75">mTan</a> (val)</td></tr>
- <tr class="separator:ga0c29659486a06c868277811e71d55a75"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8a88d5cab721957271edb846e2cde879" id="r_ga8a88d5cab721957271edb846e2cde879"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga8a88d5cab721957271edb846e2cde879">removeBitFromMask</a> (mask, <a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a>)</td></tr>
- <tr class="separator:ga8a88d5cab721957271edb846e2cde879"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga2106631b7788822a95367b32142999eb" name="ga2106631b7788822a95367b32142999eb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga2106631b7788822a95367b32142999eb">◆ </a></span>addBitToMask()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> addBitToMask </td>
- <td>(</td>
- <td class="paramtype">mask </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a> </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the mask with a bit added to it </p>
- </div>
- </div>
- <a id="ga7763021eda6826df8311f3506707206e" name="ga7763021eda6826df8311f3506707206e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga7763021eda6826df8311f3506707206e">◆ </a></span>bit()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bit </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts a bit-position into a value. </p>
- </div>
- </div>
- <a id="ga061a743f758efc28b3abfcda018ce5f8" name="ga061a743f758efc28b3abfcda018ce5f8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga061a743f758efc28b3abfcda018ce5f8">◆ </a></span>bitInverse()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bitInverse </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the ones complement of a bit. </p>
- </div>
- </div>
- <a id="ga226a173fecd58ccc2b66e185111a23ef" name="ga226a173fecd58ccc2b66e185111a23ef"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga226a173fecd58ccc2b66e185111a23ef">◆ </a></span>bits()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> bits </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts a list of bit-positions into a value. </p>
- </div>
- </div>
- <a id="gae3d373c8e4f47876e79580255fda09ca" name="gae3d373c8e4f47876e79580255fda09ca"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gae3d373c8e4f47876e79580255fda09ca">◆ </a></span>mAbs()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAbs </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAbs function to get the magnitude of val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>An integer or a floating-point value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the magnitude of val </dd></dl>
- </div>
- </div>
- <a id="gada34c6c74dfdcb11cbcfd8fa93723ae9" name="gada34c6c74dfdcb11cbcfd8fa93723ae9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gada34c6c74dfdcb11cbcfd8fa93723ae9">◆ </a></span>mAcos()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAcos </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAcos function to get the inverse cosine of val in degrees. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga57830e6b2dbe67572482a4b5484ff68a">mCos</a> </dd></dl>
- </div>
- </div>
- <a id="ga220952eb9eac31d3adffd769b82672a3" name="ga220952eb9eac31d3adffd769b82672a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga220952eb9eac31d3adffd769b82672a3">◆ </a></span>mAsin()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAsin </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAsin function to get the inverse sine of val in degrees. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gad4dee8264c82983c08d48ec494a6345a">mSin</a> </dd></dl>
- </div>
- </div>
- <a id="gac7909662d8361784ac11b2343b9cb9cf" name="gac7909662d8361784ac11b2343b9cb9cf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gac7909662d8361784ac11b2343b9cb9cf">◆ </a></span>mAtan()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mAtan </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">x-axis</td><td>run Horizontal component of a line. </td></tr>
- <tr><td class="paramname">y-axis</td><td>rise Vertical component of a line. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga0c29659486a06c868277811e71d55a75">mTan</a> </dd></dl>
- </div>
- </div>
- <a id="ga0003814a0ab34f56c612bf415df188f4" name="ga0003814a0ab34f56c612bf415df188f4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0003814a0ab34f56c612bf415df188f4">◆ </a></span>mCeil()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> mCeil </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mCeil function to calculate the next highest integer value from val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next highest integer from val. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga4212b2d30f340138e6472fe7224116d8">mFloor</a> </dd></dl>
- </div>
- </div>
- <a id="gad89b62df29c737c57d22c63a534817fe" name="gad89b62df29c737c57d22c63a534817fe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad89b62df29c737c57d22c63a534817fe">◆ </a></span>mClamp()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mClamp </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>number</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>min</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>max</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clamp a value between two other values. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">number</td><td>A float value representing the number to clamp </td></tr>
- <tr><td class="paramname">min</td><td>The lower bound </td></tr>
- <tr><td class="paramname">max</td><td>The upper bound </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A float value the is within the given range </dd></dl>
- </div>
- </div>
- <a id="ga57830e6b2dbe67572482a4b5484ff68a" name="ga57830e6b2dbe67572482a4b5484ff68a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga57830e6b2dbe67572482a4b5484ff68a">◆ </a></span>mCos()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mCos </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mCos function to get the cosine of the angle val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value in degrees. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gada34c6c74dfdcb11cbcfd8fa93723ae9">mAcos</a> </dd></dl>
- </div>
- </div>
- <a id="gaf502c5c8f38d39a4027bfcdb54d4a573" name="gaf502c5c8f38d39a4027bfcdb54d4a573"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaf502c5c8f38d39a4027bfcdb54d4a573">◆ </a></span>mDegToRad()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mDegToRad </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mDegToRad function to convert degrees to radians. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point number representing some number of degrees. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the degree value val in radians. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga1d996a02e1ddbc2328a7058cec119576">mRadToDeg</a> </dd></dl>
- </div>
- </div>
- <a id="ga10f33dc8c25d218ff0184fc9349d7fee" name="ga10f33dc8c25d218ff0184fc9349d7fee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga10f33dc8c25d218ff0184fc9349d7fee">◆ </a></span>mEase()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mEase </td>
- <td>(</td>
- <td class="paramtype">easeFunction </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">progress </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <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>
- <tr><td class="paramname">progress</td><td>Linear progress from 0 to 1. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="ga2d1f398ae7b17b53b522c761f4678b4d" name="ga2d1f398ae7b17b53b522c761f4678b4d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga2d1f398ae7b17b53b522c761f4678b4d">◆ </a></span>mFloatLength()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mFloatLength </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">numDecimals </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mFloatLength function to limit the number of decimal places in val to numDecimals. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="ga4212b2d30f340138e6472fe7224116d8" name="ga4212b2d30f340138e6472fe7224116d8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4212b2d30f340138e6472fe7224116d8">◆ </a></span>mFloor()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> mFloor </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mFloor function to calculate the next lowest integer value from val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next lowest integer from val. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga0003814a0ab34f56c612bf415df188f4">mCeil</a> </dd></dl>
- </div>
- </div>
- <a id="ga27c1afd89a939bd1cc141b78cbbe3de1" name="ga27c1afd89a939bd1cc141b78cbbe3de1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga27c1afd89a939bd1cc141b78cbbe3de1">◆ </a></span>mGetMax()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mGetMax </td>
- <td>(</td>
- <td class="paramtype">a </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">b </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the Maximum of two values. </p>
- </div>
- </div>
- <a id="gad8cf7b1316e3eab55592adc8fa1edcbc" name="gad8cf7b1316e3eab55592adc8fa1edcbc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad8cf7b1316e3eab55592adc8fa1edcbc">◆ </a></span>mGetMin()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mGetMin </td>
- <td>(</td>
- <td class="paramtype">a </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">b </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the Minimum of two values. </p>
- </div>
- </div>
- <a id="ga7d80549c4e47c06c3bcb009c742ab367" name="ga7d80549c4e47c06c3bcb009c742ab367"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga7d80549c4e47c06c3bcb009c742ab367">◆ </a></span>mLog()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mLog </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mLog function to calculate the natural logarithm of val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the natural logarithm of val </dd></dl>
- </div>
- </div>
- <a id="gaaf03cec597971519aa33dfc8de539ad4" name="gaaf03cec597971519aa33dfc8de539ad4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaaf03cec597971519aa33dfc8de539ad4">◆ </a></span>mPow()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mPow </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">power </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mPow function to calculated val raised to the power of power. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A numeric (integer or floating-point) value to be raised to a power. </td></tr>
- <tr><td class="paramname">power</td><td>A numeric (integer or floating-point) power to raise val to. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns val^power </dd></dl>
- </div>
- </div>
- <a id="ga1d996a02e1ddbc2328a7058cec119576" name="ga1d996a02e1ddbc2328a7058cec119576"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga1d996a02e1ddbc2328a7058cec119576">◆ </a></span>mRadToDeg()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mRadToDeg </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mRadToDeg function to convert radians to degrees. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point number representing some number of radians. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the radian value val in degrees. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gaf502c5c8f38d39a4027bfcdb54d4a573">mDegToRad</a> </dd></dl>
- </div>
- </div>
- <a id="gaa532d15c461ad665c6ca1f208f4edb99" name="gaa532d15c461ad665c6ca1f208f4edb99"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaa532d15c461ad665c6ca1f208f4edb99">◆ </a></span>mRound()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mRound </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rounds a number. 0.5 is rounded up. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the integer value closest to the given float </dd></dl>
- </div>
- </div>
- <a id="gad4dee8264c82983c08d48ec494a6345a" name="gad4dee8264c82983c08d48ec494a6345a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad4dee8264c82983c08d48ec494a6345a">◆ </a></span>mSin()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mSin </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mSin function to get the sine of the angle val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value in degrees. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#ga220952eb9eac31d3adffd769b82672a3">mAsin</a> </dd></dl>
- </div>
- </div>
- <a id="ga0905f7ed2523c11ab28215969d34e8f9" name="ga0905f7ed2523c11ab28215969d34e8f9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0905f7ed2523c11ab28215969d34e8f9">◆ </a></span>mSolveCubic()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveCubic </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>a</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>b</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>c</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>d</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="ga76d1f6e842a6a9d50dedf4589739b422" name="ga76d1f6e842a6a9d50dedf4589739b422"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga76d1f6e842a6a9d50dedf4589739b422">◆ </a></span>mSolveQuadratic()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveQuadratic </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>a</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>b</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>c</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="ga9a6bd90dad704a305b65bfafd1872ead" name="ga9a6bd90dad704a305b65bfafd1872ead"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga9a6bd90dad704a305b65bfafd1872ead">◆ </a></span>mSolveQuartic()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> mSolveQuartic </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>a</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>b</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>c</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>e</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="gaf1f8e9ea7921dec013f9e691df32b572" name="gaf1f8e9ea7921dec013f9e691df32b572"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaf1f8e9ea7921dec013f9e691df32b572">◆ </a></span>mSqrt()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mSqrt </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mSqrt function to calculated the square root of val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the the squareroot of val </dd></dl>
- </div>
- </div>
- <a id="ga0c29659486a06c868277811e71d55a75" name="ga0c29659486a06c868277811e71d55a75"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0c29659486a06c868277811e71d55a75">◆ </a></span>mTan()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> mTan </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mTan function to get the tangent of the angle val. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value in degrees. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MathFunctions.html#gac7909662d8361784ac11b2343b9cb9cf">mAtan</a> </dd></dl>
- </div>
- </div>
- <a id="ga8a88d5cab721957271edb846e2cde879" name="ga8a88d5cab721957271edb846e2cde879"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga8a88d5cab721957271edb846e2cde879">◆ </a></span>removeBitFromMask()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> removeBitFromMask </td>
- <td>(</td>
- <td class="paramtype">mask </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__MathFunctions.html#ga7763021eda6826df8311f3506707206e">bit</a> </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the mask with a bit removed from it </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|