RandomNumberGenerator.xml 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RandomNumberGenerator" inherits="Reference" category="Core" version="3.1">
  3. <brief_description>
  4. A class for generation pseudo-random numbers.
  5. </brief_description>
  6. <description>
  7. </description>
  8. <tutorials>
  9. </tutorials>
  10. <demos>
  11. </demos>
  12. <methods>
  13. <method name="randf">
  14. <return type="float">
  15. </return>
  16. <description>
  17. Generates pseudo-random float between '0.0' and '1.0'.
  18. </description>
  19. </method>
  20. <method name="randf_range">
  21. <return type="float">
  22. </return>
  23. <argument index="0" name="from" type="float">
  24. </argument>
  25. <argument index="1" name="to" type="float">
  26. </argument>
  27. <description>
  28. Generates pseudo-random float between [code]from[/code] and [code]to[/code].
  29. </description>
  30. </method>
  31. <method name="randi">
  32. <return type="int">
  33. </return>
  34. <description>
  35. Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295'.
  36. </description>
  37. </method>
  38. <method name="randi_range">
  39. <return type="int">
  40. </return>
  41. <argument index="0" name="from" type="int">
  42. </argument>
  43. <argument index="1" name="to" type="int">
  44. </argument>
  45. <description>
  46. Generates pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code](inclusive).
  47. </description>
  48. </method>
  49. <method name="randomize">
  50. <return type="void">
  51. </return>
  52. <description>
  53. Setups a time-based seed to generator.
  54. </description>
  55. </method>
  56. </methods>
  57. <members>
  58. <member name="seed" type="int" setter="set_seed" getter="get_seed">
  59. </member>
  60. </members>
  61. <constants>
  62. </constants>
  63. </class>