Input

util.input.get_mouse_sensitivity

Client

Retrieves the mouse sensitivity multiplier of the specified axis

Syntax

local sensitivity = util.input.get_mouse_sensitivity(
    axis
)

Parameters

TypeNameDescription
util.input.mouse_axisaxisMouse axis to retrieve the sensitivity of

Returns

TypeNameDescription
floatsensitivitySensitivity multiplier of the specified axis, ranging from 0.01 to 2.0

Examples

Print the mouse sensitivity of each axis
core.engine.print("info", "Horizontal sensitivity:", util.input.get_mouse_sensitivity(util.input.mouse_axis.HORIZONTAL))
core.engine.print("info", "Vertical sensitivity:", util.input.get_mouse_sensitivity(util.input.mouse_axis.VERTICAL))
Scale FPS camera rotation by the player's mouse sensitivity
util.input.set_cursor_mode(util.input.cursor_mode.CAPTURED)

local base_sensitivity = 0.1
local velocity = util.input.get_cursor_velocity()
local yaw = velocity[1]*base_sensitivity*util.input.get_mouse_sensitivity(util.input.mouse_axis.HORIZONTAL)
local pitch = velocity[2]*base_sensitivity*util.input.get_mouse_sensitivity(util.input.mouse_axis.VERTICAL)

core.engine.print("info", "Yaw delta:", yaw, "Pitch delta:", pitch)

On this page