removePoint.lua 580 B

1234567891011121314151617181920212223242526
  1. return {
  2. summary = 'Remove a control point from the Curve.',
  3. description = 'Removes a control point from the Curve.',
  4. arguments = {
  5. index = {
  6. type = 'number',
  7. description = 'The index of the control point to remove.'
  8. }
  9. },
  10. returns = {},
  11. variants = {
  12. {
  13. arguments = { 'index' },
  14. returns = {}
  15. }
  16. },
  17. notes = [[
  18. An error will be thrown if the index is less than one or more than the number of control points.
  19. ]],
  20. related = {
  21. 'Curve:getPointCount',
  22. 'Curve:getPoint',
  23. 'Curve:setPoint',
  24. 'Curve:addPoint'
  25. }
  26. }