| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118 |
- <!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: RandomNumberGenerator Class Reference</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="#pub-methods">Public Member Functions</a> |
- <a href="classRandomNumberGenerator-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">RandomNumberGenerator Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <RandomNumberGenerator_ScriptBinding.h></code></p>
- <p>Inherits <a class="el" href="classScriptObject.html">ScriptObject</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a8a6887056c3d872fa90f4831fce148b1" id="r_a8a6887056c3d872fa90f4831fce148b1"><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="classRandomNumberGenerator.html#a8a6887056c3d872fa90f4831fce148b1">getRandom</a> ([int bound])</td></tr>
- <tr class="separator:a8a6887056c3d872fa90f4831fce148b1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a703d8bb20fc114e98156e1c04f084238" id="r_a703d8bb20fc114e98156e1c04f084238"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRandomNumberGenerator.html#a703d8bb20fc114e98156e1c04f084238">setSeed</a> (int seed, [int stream])</td></tr>
- <tr class="separator:a703d8bb20fc114e98156e1c04f084238"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a8a6887056c3d872fa90f4831fce148b1" name="a8a6887056c3d872fa90f4831fce148b1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8a6887056c3d872fa90f4831fce148b1">◆ </a></span>getRandom()</h2>
- <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="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns a random number integer value between 0 and an optional upper bound. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">bound</td><td>The optional value that the random number will be less than. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A 32 bit number or a value where 0 <= number < bound. </dd></dl>
- </div>
- </div>
- <a id="a703d8bb20fc114e98156e1c04f084238" name="a703d8bb20fc114e98156e1c04f084238"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a703d8bb20fc114e98156e1c04f084238">◆ </a></span>setSeed()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setSeed </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>seed</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the seed and stream for the random number generater. Random values will always be the same for a seed/stream combination. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">seed</td><td>An integer seed value. </td></tr>
- <tr><td class="paramname">stream</td><td>An optional integer value for the stream. If no stream is set a random stream value will be picked. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </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>
|