lovr-indeck/lovr-api/headset/wasPressed.lua

return {
  tag = 'input',
  summary = 'Check if a button was just pressed.',
  description = 'Returns whether a button on a device was pressed this frame.',
  arguments = {
    device = {
      type = 'Device',
      description = 'The device.'
    },
    button = {
      type = 'DeviceButton',
      description = 'The button to check.'
    }
  },
  returns = {
    pressed = {
      type = 'boolean',
      description = 'Whether the button on the device was pressed this frame.'
    }
  },
  variants = {
    {
      arguments = { 'device', 'button' },
      returns = { 'pressed' }
    }
  },
  notes = [[
    Some headset backends are not able to return pressed/released information.  These drivers will
    always return false for `lovr.headset.wasPressed` and `lovr.headset.wasReleased`.

    Typically the internal `lovr.headset.update` function will update pressed/released status.
  ]],
  related = {
    'DeviceButton',
    'lovr.headset.isDown',
    'lovr.headset.wasReleased',
    'lovr.headset.isTouched',
    'lovr.headset.getAxis'
  }
}