getAnimationDuration.lua 787 B

123456789101112131415161718192021222324252627282930313233343536
  1. return {
  2. summary = 'Get the duration of an animation.',
  3. description = 'Returns the duration of an animation.',
  4. arguments = {
  5. index = {
  6. type = 'number',
  7. description = 'The index of the animation.'
  8. },
  9. name = {
  10. type = 'string',
  11. description = 'The name of the animation.'
  12. }
  13. },
  14. returns = {
  15. duration = {
  16. type = 'number',
  17. description = 'The duration of the animation, in seconds.'
  18. }
  19. },
  20. variants = {
  21. {
  22. arguments = { 'index' },
  23. returns = { 'duration' }
  24. },
  25. {
  26. arguments = { 'name' },
  27. returns = { 'duration' }
  28. }
  29. },
  30. notes = [[
  31. The duration of the animation is calculated as the latest timestamp of all of its channels.
  32. ]],
  33. related = {
  34. 'Model:getAnimationDuration'
  35. }
  36. }