setPoint.lua 797 B

123456789101112131415161718192021222324252627282930313233343536
  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. {
  6. name = 'index',
  7. type = 'number',
  8. description = 'The index to modify.'
  9. },
  10. {
  11. name = 'x',
  12. type = 'number',
  13. description = 'The new x coordinate.'
  14. },
  15. {
  16. name = 'y',
  17. type = 'number',
  18. description = 'The new y coordinate.'
  19. },
  20. {
  21. name = 'z',
  22. type = 'number',
  23. description = 'The new z coordinate.'
  24. }
  25. },
  26. returns = {},
  27. notes = [[
  28. An error will be thrown if the index is less than one or more than the number of control points.
  29. ]],
  30. related = {
  31. 'Curve:getPointCount',
  32. 'Curve:getPoint',
  33. 'Curve:addPoint',
  34. 'Curve:removePoint'
  35. }
  36. }