setKinematic.lua 622 B

12345678910111213141516171819202122
  1. return {
  2. summary = 'Set whether the Collider is kinematic.',
  3. description = 'Sets whether the Collider is kinematic.',
  4. arguments = {
  5. kinematic = {
  6. type = 'boolean',
  7. description = 'Whether the Collider is kinematic.'
  8. }
  9. },
  10. returns = {},
  11. variants = {
  12. {
  13. arguments = { 'kinematic' },
  14. returns = {}
  15. }
  16. },
  17. notes = [[
  18. Kinematic colliders behave as though they have infinite mass, ignoring external forces like
  19. gravity, joints, or collisions (though non-kinematic colliders will collide with them). They can
  20. be useful for static objects like floors or walls.
  21. ]]
  22. }