getMeshIndex.lua 979 B

123456789101112131415161718192021222324252627282930313233343536
  1. return {
  2. summary = 'Get one of the vertex indices in a mesh.',
  3. description = [[
  4. Returns one of the vertex indices in a mesh. If a mesh has vertex indices, they define the
  5. order and connectivity of the vertices in the mesh, allowing a vertex to be reused multiple
  6. times without duplicating its data.
  7. ]],
  8. arguments = {
  9. mesh = {
  10. type = 'number',
  11. description = 'The index of a mesh to get the vertex from.'
  12. },
  13. index = {
  14. type = 'number',
  15. description = 'The index of a vertex index in the mesh to retrieve.'
  16. }
  17. },
  18. returns = {
  19. vertexindex = {
  20. type = 'number',
  21. description = 'The vertex index. Like all indices in Lua, this is 1-indexed.'
  22. }
  23. },
  24. variants = {
  25. {
  26. arguments = { 'mesh', 'index' },
  27. returns = { 'vertexindex' }
  28. }
  29. },
  30. related = {
  31. 'ModelData:getMeshIndexFormat',
  32. 'ModelData:getMeshIndexCount',
  33. 'ModelData:getMeshVertex',
  34. 'ModelData:getTriangles'
  35. }
  36. }