getResponseTime.lua 997 B

1234567891011121314151617181920212223242526272829303132333435
  1. return {
  2. tag = 'worldProperties',
  3. summary = 'Get the response time of the World.',
  4. description = [[
  5. Returns the response time factor of the World.
  6. The response time controls how relaxed collisions and joints are in the physics simulation, and
  7. functions similar to inertia. A low response time means collisions are resolved quickly, and
  8. higher values make objects more spongy and soft.
  9. The value can be any positive number. It can be changed on a per-joint basis for
  10. `DistanceJoint` and `BallJoint` objects.
  11. ]],
  12. arguments = {},
  13. returns = {
  14. responseTime = {
  15. type = 'number',
  16. description = 'The response time setting for the World.'
  17. }
  18. },
  19. variants = {
  20. {
  21. arguments = {},
  22. returns = { 'responseTime' }
  23. }
  24. },
  25. related = {
  26. 'BallJoint:getResponseTime',
  27. 'BallJoint:setResponseTime',
  28. 'DistanceJoint:getResponseTime',
  29. 'DistanceJoint:setResponseTime',
  30. 'World:getTightness',
  31. 'World:setTightness'
  32. }
  33. }