classRandomNumberGenerator.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: RandomNumberGenerator Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classRandomNumberGenerator-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">RandomNumberGenerator Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;RandomNumberGenerator_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classScriptObject.html">ScriptObject</a>.</p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:a8a6887056c3d872fa90f4831fce148b1" id="r_a8a6887056c3d872fa90f4831fce148b1"><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="classRandomNumberGenerator.html#a8a6887056c3d872fa90f4831fce148b1">getRandom</a> ([int bound])</td></tr>
  55. <tr class="separator:a8a6887056c3d872fa90f4831fce148b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a703d8bb20fc114e98156e1c04f084238" id="r_a703d8bb20fc114e98156e1c04f084238"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRandomNumberGenerator.html#a703d8bb20fc114e98156e1c04f084238">setSeed</a> (int seed, [int stream])</td></tr>
  57. <tr class="separator:a703d8bb20fc114e98156e1c04f084238"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. </table>
  59. <h2 class="groupheader">Member Function Documentation</h2>
  60. <a id="a8a6887056c3d872fa90f4831fce148b1" name="a8a6887056c3d872fa90f4831fce148b1"></a>
  61. <h2 class="memtitle"><span class="permalink"><a href="#a8a6887056c3d872fa90f4831fce148b1">&#9670;&#160;</a></span>getRandom()</h2>
  62. <div class="memitem">
  63. <div class="memproto">
  64. <table class="memname">
  65. <tr>
  66. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getRandom </td>
  67. <td>(</td>
  68. <td class="paramname"></td><td>)</td>
  69. <td></td>
  70. </tr>
  71. </table>
  72. </div><div class="memdoc">
  73. <p>Returns a random number integer value between 0 and an optional upper bound. </p><dl class="params"><dt>Parameters</dt><dd>
  74. <table class="params">
  75. <tr><td class="paramname">bound</td><td>The optional value that the random number will be less than. </td></tr>
  76. </table>
  77. </dd>
  78. </dl>
  79. <dl class="section return"><dt>Returns</dt><dd>A 32 bit number or a value where 0 &lt;= number &lt; bound. </dd></dl>
  80. </div>
  81. </div>
  82. <a id="a703d8bb20fc114e98156e1c04f084238" name="a703d8bb20fc114e98156e1c04f084238"></a>
  83. <h2 class="memtitle"><span class="permalink"><a href="#a703d8bb20fc114e98156e1c04f084238">&#9670;&#160;</a></span>setSeed()</h2>
  84. <div class="memitem">
  85. <div class="memproto">
  86. <table class="memname">
  87. <tr>
  88. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setSeed </td>
  89. <td>(</td>
  90. <td class="paramtype">int&#160;</td>
  91. <td class="paramname"><em>seed</em></td><td>)</td>
  92. <td></td>
  93. </tr>
  94. </table>
  95. </div><div class="memdoc">
  96. <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>
  97. <table class="params">
  98. <tr><td class="paramname">seed</td><td>An integer seed value. </td></tr>
  99. <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>
  100. </table>
  101. </dd>
  102. </dl>
  103. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  104. </div>
  105. </div>
  106. </div><!-- contents -->
  107. <!-- start footer part -->
  108. <hr class="footer"/><address class="footer"><small>
  109. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  110. </small></address>
  111. </body>
  112. </html>