getStepCount.lua 574 B

12345678910111213141516171819202122232425
  1. return {
  2. tag = 'worldProperties',
  3. summary = 'Get the step count of the World.',
  4. description = [[
  5. Returns the step count of the World. The step count influences how many steps are taken during
  6. a call to `World:update`. A higher number of steps will be slower, but more accurate. The
  7. default step count is 20.
  8. ]],
  9. arguments = {},
  10. returns = {
  11. steps = {
  12. type = 'number',
  13. description = 'The step count.'
  14. }
  15. },
  16. variants = {
  17. {
  18. arguments = {},
  19. returns = { 'steps' }
  20. }
  21. },
  22. related = {
  23. 'World:update'
  24. }
  25. }