isKeyDown.lua 611 B

1234567891011121314151617181920212223242526272829
  1. return {
  2. tag = 'system-keyboard',
  3. summary = 'Get the state of a key.',
  4. description = 'Returns whether a key on the keyboard is pressed.',
  5. arguments = {
  6. ['...'] = {
  7. type = 'KeyCode',
  8. description = 'The set of keys to check.'
  9. }
  10. },
  11. returns = {
  12. down = {
  13. type = 'boolean',
  14. description = 'Whether any of the keys are currently pressed.'
  15. }
  16. },
  17. variants = {
  18. {
  19. arguments = { '...' },
  20. returns = { 'down' }
  21. }
  22. },
  23. related = {
  24. 'lovr.system.wasKeyPressed',
  25. 'lovr.system.wasKeyReleased',
  26. 'lovr.keypressed',
  27. 'lovr.keyreleased'
  28. }
  29. }