setState.lua 625 B

123456789101112131415161718192021222324
  1. return {
  2. summary = 'Set the state of the RandomGenerator.',
  3. description = [[
  4. Sets the state of the RandomGenerator, as previously obtained using `RandomGenerator:getState`.
  5. This can be used to reliably restore a previous state of the generator.
  6. ]],
  7. arguments = {
  8. state = {
  9. type = 'string',
  10. description = 'The serialized state.'
  11. }
  12. },
  13. returns = {},
  14. variants = {
  15. {
  16. arguments = { 'state' },
  17. returns = {}
  18. }
  19. },
  20. notes = [[
  21. The seed represents the starting state of the RandomGenerator, whereas the state represents the
  22. current state of the generator.
  23. ]]
  24. }