TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
							<!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"/>
<title>RandomNumbers</title>
<link href="torquedoc.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<table width="100%" class="header">
<tr>
</tr>
<tr><td class="headermenu">
	<center>
	<a class="qindex" href="index.html">Main</a> &nbsp; 
	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
	</center>
</td></tr>
</table>
<br>
<!-- END HEADER -->
<!-- Generated by Doxygen 1.8.3.1 -->
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">RandomNumbers</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:ga3eea53088476156e2dfa9b5b8aa8e090"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbers.html#ga3eea53088476156e2dfa9b5b8aa8e090">getRandom</a> ([min],[max])</td></tr>
<tr class="separator:ga3eea53088476156e2dfa9b5b8aa8e090"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee1e4ac101b0a9d3300985b0f64a3d69"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbers.html#gaee1e4ac101b0a9d3300985b0f64a3d69">getRandomF</a> (min, max)</td></tr>
<tr class="separator:gaee1e4ac101b0a9d3300985b0f64a3d69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06945c9e4e18fcc6e12334f2128bdf6e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RandomNumbers.html#ga06945c9e4e18fcc6e12334f2128bdf6e">getRandomSeed</a> ()</td></tr>
<tr class="separator:ga06945c9e4e18fcc6e12334f2128bdf6e"><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__RandomNumbers.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>
<p>Functions relating to the generation of random numbers. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga3eea53088476156e2dfa9b5b8aa8e090"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float getRandom </td>
          <td>(</td>
          <td class="paramname"></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__RandomNumbers.html#ga3eea53088476156e2dfa9b5b8aa8e090">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__RandomNumbers.html#ga06945c9e4e18fcc6e12334f2128bdf6e">getRandomSeed</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaee1e4ac101b0a9d3300985b0f64a3d69"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="ga06945c9e4e18fcc6e12334f2128bdf6e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int 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__RandomNumbers.html#ga3eea53088476156e2dfa9b5b8aa8e090">getRandom</a>, <a class="el" href="group__RandomNumbers.html#ga5bf7e67964cfdabe26ad5b514701a0df">setRandomSeed</a> </dd></dl>

</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__RandomNumbers.html#ga3eea53088476156e2dfa9b5b8aa8e090">getRandom</a>, <a class="el" href="group__RandomNumbers.html#ga06945c9e4e18fcc6e12334f2128bdf6e">getRandomSeed</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- START FOOTER -->
<br>
<br>
<center>
	<div style="color: #777777;">
	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
	</div>
</center>
</body>
</html>