setAwake.lua 557 B

123456789101112131415161718192021
  1. return {
  2. summary = 'Put the Collider to sleep or wake it up.',
  3. description = [[
  4. Manually puts the Collider to sleep or wakes it up. You can do this if you know a Collider
  5. won't be touched for a while or if you need to it be active.
  6. ]],
  7. arguments = {
  8. {
  9. name = 'awake',
  10. type = 'boolean',
  11. description = 'Whether the Collider should be awake.'
  12. }
  13. },
  14. returns = {},
  15. related = {
  16. 'World:isSleepingAllowed',
  17. 'World:setSleepingAllowed',
  18. 'Collider:isSleepingAllowed',
  19. 'Collider:setSleepingAllowed'
  20. }
  21. }