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

return {
  tag = 'input',
  summary = 'Get the state of a button on a device.',
  description = 'Returns whether a button on a device is pressed.',
  arguments = {
    device = {
      type = 'Device',
      description = 'The device.'
    },
    button = {
      type = 'DeviceButton',
      description = 'The button.'
    }
  },
  returns = {
    down = {
      type = 'boolean',
      description = [[
        Whether the button on the device is currently pressed, or `nil` if the device does not have
        the specified button.
      ]]
    }
  },
  variants = {
    {
      arguments = { 'device', 'button' },
      returns = { 'down' }
    }
  },
  notes = 'When hand tracking is active, pinching will be mapped to the `trigger` button.',
  related = {
    'DeviceButton',
    'lovr.headset.wasPressed',
    'lovr.headset.wasReleased',
    'lovr.headset.isTouched',
    'lovr.headset.getAxis'
  }
}