getSize.lua 628 B

1234567891011121314151617181920212223
  1. return {
  2. summary = 'Get the size of the layer.',
  3. description = [[
  4. Returns the width and height of the layer. This is the size of the plane the layer is rendered
  5. onto, not the resolution of the layer's texture in pixels.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. width = {
  10. type = 'number',
  11. description = 'The width of the layer, in meters.'
  12. },
  13. height = {
  14. type = 'number',
  15. description = 'The height of the layer, in meters.'
  16. }
  17. },
  18. variants = {
  19. arguments = {},
  20. returns = { 'width', 'height' }
  21. },
  22. notes = 'When a layer is created, its width and height are 1 meter.'
  23. }