TorqueEngine
/
Torque2D
Mirror von https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>TorqueScript Reference: Random Numbers</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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Random Numbers<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 name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7c71337aae6090b45b5cb2d68d3f469b"><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__RandomNumbersFunctions.html#ga7c71337aae6090b45b5cb2d68d3f469b">getRandom</a> ([min]?,[max]?)</td></tr>
<tr class="separator:ga7c71337aae6090b45b5cb2d68d3f469b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa61b878a209a1da601838f57933de055"><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__RandomNumbersFunctions.html#gaa61b878a209a1da601838f57933de055">getRandomF</a> (min, max)</td></tr>
<tr class="separator:gaa61b878a209a1da601838f57933de055"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9c56927aa9d8767f81fb489620a8809"><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__RandomNumbersFunctions.html#gae9c56927aa9d8767f81fb489620a8809">getRandomSeed</a> ()</td></tr>
<tr class="separator:gae9c56927aa9d8767f81fb489620a8809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0e43697ecd1fd287575d886903cb907"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbersFunctions.html#gad0e43697ecd1fd287575d886903cb907">mRandF</a> (const F32 f1, const F32 f2)</td></tr>
<tr class="separator:gad0e43697ecd1fd287575d886903cb907"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9233afc852115277a3af8e99edb0946"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbersFunctions.html#gaf9233afc852115277a3af8e99edb0946">mRandI</a> (const S32 i1, const S32 i2)</td></tr>
<tr class="separator:gaf9233afc852115277a3af8e99edb0946"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5bf7e67964cfdabe26ad5b514701a0df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbersFunctions.html#ga5bf7e67964cfdabe26ad5b514701a0df">setRandomSeed</a> (startSeed)</td></tr>
<tr class="separator:ga5bf7e67964cfdabe26ad5b514701a0df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga7c71337aae6090b45b5cb2d68d3f469b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getRandom </td>
          <td>(</td>
          <td class="paramtype">[ min ] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[ max ] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getRandom function to get a random floating-point or integer value. This function comes in three forms. The first <a class="el" href="group__RandomNumbersFunctions.html#ga7c71337aae6090b45b5cb2d68d3f469b">getRandom()</a> takes no arguments and will return a random floating-point value in the range of 0.0 to 1.0. The second getRandom( max ) takes one argument representing the max integer value this will return. It will return an integer value between 0 and max. The third getRandom( min , max ) takes two arguments representing the min and max integer values this will return. It will return an integer value between min and max. Only the no-args version will return a floating point. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">min</td><td>Minimum inclusive integer value to return. </td></tr>
    <tr><td class="paramname">max</td><td>Maximum inclusive integer value to return. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If no arguments are passed, will return a floating-point value between 0.0 and 1.0. If one argument is passed, will return an integer value between 0 and max inclusive. If two arguments are passed, will return an integer value between min and max inclusive. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__RandomNumbersFunctions.html#gae9c56927aa9d8767f81fb489620a8809">getRandomSeed</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaa61b878a209a1da601838f57933de055"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getRandomF </td>
          <td>(</td>
          <td class="paramtype">min&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">max&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets a random floating-point number from min to max. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">min</td><td>The minimum range of the random floating-point number. </td></tr>
    <tr><td class="paramname">max</td><td>The maximum range of the random floating-point number. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A random floating-point number from min to max. </dd></dl>

</div>
</div>
<a class="anchor" id="gae9c56927aa9d8767f81fb489620a8809"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getRandomSeed </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getRandomSeed function to get the current seed for the random generator. You can re-seed the generator with this value to allow you to recreate a random sequence. Merely save the seed and execute your random sequence. Later, to reproduce this sequence re-seed the generator with setRandomSeed and your saved value. Then, the generator will produce the same random sequence that followed the call to getRandomSeed. </p><dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the current seed of the random generator. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__RandomNumbersFunctions.html#ga7c71337aae6090b45b5cb2d68d3f469b">getRandom</a>, <a class="el" href="group__RandomNumbersFunctions.html#ga5bf7e67964cfdabe26ad5b514701a0df">setRandomSeed</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gad0e43697ecd1fd287575d886903cb907"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">F32 mRandF </td>
          <td>(</td>
          <td class="paramtype">const F32&#160;</td>
          <td class="paramname"><em>f1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const F32&#160;</td>
          <td class="paramname"><em>f2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="gaf9233afc852115277a3af8e99edb0946"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">S32 mRandI </td>
          <td>(</td>
          <td class="paramtype">const S32&#160;</td>
          <td class="paramname"><em>i1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const S32&#160;</td>
          <td class="paramname"><em>i2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga5bf7e67964cfdabe26ad5b514701a0df"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setRandomSeed </td>
          <td>(</td>
          <td class="paramtype">startSeed&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setRandomSeed function to initialize the random number generator with the initial seed of startSeed. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">startSeed</td><td>The new starting seed value for the random generator. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__RandomNumbersFunctions.html#ga7c71337aae6090b45b5cb2d68d3f469b">getRandom</a>, <a class="el" href="group__RandomNumbersFunctions.html#gae9c56927aa9d8767f81fb489620a8809">getRandomSeed</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>