getColor.lua 790 B

1234567891011121314151617181920212223242526272829303132
  1. return {
  2. tag = 'graphicsState',
  3. summary = 'Get the global color factor.',
  4. description = [[
  5. Returns the current global color factor. Color components are from 0.0 to 1.0. Every pixel
  6. drawn will be multiplied (i.e. tinted) by this color.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. {
  11. name = 'r',
  12. type = 'number',
  13. description = 'The red component of the color.'
  14. },
  15. {
  16. name = 'g',
  17. type = 'number',
  18. description = 'The green component of the color.'
  19. },
  20. {
  21. name = 'b',
  22. type = 'number',
  23. description = 'The blue component of the color.'
  24. },
  25. {
  26. name = 'a',
  27. type = 'number',
  28. description = 'The alpha component of the color.'
  29. }
  30. },
  31. notes = 'The default color is `(1.0, 1.0, 1.0, 1.0)`.'
  32. }