getTightness.lua 888 B

123456789101112131415161718192021222324252627282930
  1. return {
  2. tag = 'worldProperties',
  3. summary = 'Get the tightness of joints in the World.',
  4. description = [[
  5. Returns 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. returns = {
  14. tightness = {
  15. type = 'number',
  16. description = 'The tightness of the World.'
  17. }
  18. },
  19. variants = {
  20. {
  21. arguments = {},
  22. returns = { 'tightness' }
  23. }
  24. },
  25. related = {
  26. 'DistanceJoint:getTightness',
  27. 'DistanceJoint:setTightness'
  28. }
  29. }