getBoundsGeometry.lua 752 B

123456789101112131415161718192021222324252627282930
  1. return {
  2. tag = 'playArea',
  3. summary = 'Get a list of points that make up the play area boundary.',
  4. description = [[
  5. Returns a list of points representing the boundaries of the play area, or `nil` if the current
  6. headset driver does not expose this information.
  7. ]],
  8. arguments = {
  9. t = {
  10. type = 'table',
  11. default = 'nil',
  12. description = 'A table to fill with the points. If `nil`, a new table will be created.'
  13. }
  14. },
  15. returns = {
  16. points = {
  17. type = 'table',
  18. description = 'A flat table of 3D points representing the play area boundaries.'
  19. }
  20. },
  21. variants = {
  22. {
  23. arguments = { 't' },
  24. returns = { 'points' }
  25. }
  26. },
  27. related = {
  28. 'lovr.headset.getBoundsDimensions'
  29. }
  30. }