setTightness.lua 1008 B

12345678910111213141516171819202122232425262728293031323334
  1. return {
  2. tag = 'worldProperties',
  3. summary = 'Set the tightness of joints in the World.',
  4. description = [[
  5. Sets the tightness of joints in the World.
  6. The tightness controls how much force is applied to colliders connected by joints. With a value
  7. of 0, no force will be applied and joints won't have any effect. With a tightness of 1, a
  8. strong force will be used to try to keep the Colliders constrained. A tightness larger than 1
  9. will overcorrect the joints, which can sometimes be desirable. Negative tightness values are
  10. not supported.
  11. ]],
  12. arguments = {
  13. tightness = {
  14. type = 'number',
  15. description = 'The new tightness for the World.'
  16. }
  17. },
  18. returns = {},
  19. variants = {
  20. {
  21. arguments = { 'tightness' },
  22. returns = {}
  23. }
  24. },
  25. related = {
  26. 'BallJoint:getTightness',
  27. 'BallJoint:setTightness',
  28. 'DistanceJoint:getTightness',
  29. 'DistanceJoint:setTightness',
  30. 'World:getResponseTime',
  31. 'World:setResponseTime'
  32. }
  33. }