setPoint.lua 838 B

1234567891011121314151617181920212223242526272829303132333435363738
  1. return {
  2. summary = 'Set a control point of the Curve.',
  3. description = 'Changes the position of a control point on the Curve.',
  4. arguments = {
  5. index = {
  6. type = 'number',
  7. description = 'The index to modify.'
  8. },
  9. x = {
  10. type = 'number',
  11. description = 'The new x coordinate.'
  12. },
  13. y = {
  14. type = 'number',
  15. description = 'The new y coordinate.'
  16. },
  17. z = {
  18. type = 'number',
  19. description = 'The new z coordinate.'
  20. }
  21. },
  22. returns = {},
  23. variants = {
  24. {
  25. arguments = { 'index', 'x', 'y', 'z' },
  26. returns = {}
  27. }
  28. },
  29. notes = [[
  30. An error will be thrown if the index is less than one or more than the number of control points.
  31. ]],
  32. related = {
  33. 'Curve:getPointCount',
  34. 'Curve:getPoint',
  35. 'Curve:addPoint',
  36. 'Curve:removePoint'
  37. }
  38. }