object.minValue

Overview

Indicates the minimum value that an axis input event will provide. This property and the object.maxValue property are needed to make sense of the raw data received by an axis because it will indicate how far that axis has been moved relative to its range.

Gotchas

• A joystick typically has a maximum and minimum value range of 1.0 and -1.0 respectively.

• A touchscreen's maximum value will usually be the length of the screen in pixels, with a minimum value of 0.

• A touchpad's maximum value is typically a large value using an unknown unit of measure, meaning that you have to evaluate the relative position of the received axis data based on the minimum and maximum value properties.

Example

-- Fetch all input devices currently connected to the system
local inputDevices = system.getInputDevices()

-- Traverse all input devices
for deviceIndex = 1,#inputDevices do
    -- Fetch the input device's axes
    local inputAxes = inputDevices[deviceIndex]:getAxes()

    -- Print all axis minimum property values to the log
    for axisIndex = 1,#inputAxes do
        local inputAxis = inputAxes[axisIndex]
        print( inputAxis.descriptor .. ": Min value = " .. tostring(inputAxis.minValue) )
    end
end