object.permanentId

Type String
Object InputDevice
Revision Current Public Release (2017.3068)
Keywords device, input, permanentId

Overview

Provides the input device's unique string ID which will be consistent between reboots. That is, the ID for the input device will not change after rebooting the system. This means that this ID can be saved to file and used to set up key bindings with a very specific input device.

This ID will be unique amongst all physical input devices. This includes devices of the same model and manufacturer. However, note that Corona will sometimes provide multiple InputDevice objects for the same physical input device if it features multiple input types. For example, an Ouya game controller has a touchpad and Corona will report it as two InputDevice objects, a Joystick and a Mouse, both having the same permanent IDs.

Will return nil if the device does not have a permanent string ID assigned to it.

Example

-- Called when a key event has been received.
local function onKeyEvent( event )
    if event.device then
        print( "Device's Permanent String ID: " .. tostring( event.device.permanentId ) )
    end
end

-- Set up the above function to receive key events.
Runtime:addEventListener( "key", onKeyEvent )