docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    UI Input Module component reference

    Use the UI Input Module to configure UI-specific actions and inputs. To view the UI Input Module, refer to Access the UI Input Module.

    The properties on the UI Input Module correspond to the InputSystemUIInputModule class.

    Property Description
    Move Repeat Delay The initial delay (in seconds) between generating an initial IMoveHandler.OnMove navigation event and generating repeated navigation events when the Move action stays actuated.
    Move Repeat Rate The interval (in seconds) between generating repeat navigation events when the Move action stays actuated. Note that this is capped by the frame rate; there will not be more than one move repeat event each frame so if the frame rate dips below the repeat rate, the effective repeat rate will be lower than this setting.
    XR Tracking Origin Define the transform that represents the real-world transform for tracking devices.
    Deselect on Background Click Clear the current selection when the pointer is clicked and does not hit any GameObject. To prevent automatic deselection, deactivate this property.
    Pointer Behavior How to deal with multiple pointers feeding input into the UI. Refer to pointer-type input. The options are:

    - Single Mouse or Pen But Multi Touch And Track: Behaves like Single Unified Pointer for all input that is not classified as touch or tracked input, and behaves like All Pointers As Is for tracked and touch input.
    - Single Unified Pointer: All pointer input is unified such that there is only ever a single pointer. This includes touch and tracked input.
    - All Pointers As Is: The UI Input Module does not unify any pointer input. Any device, including touch and tracked devices that feed pointer input actions, has its own pointer (or multiple pointers for touch input).

    For more details on these pointer behaviors, refer to Pointer input UI support: Pointer behavior.
    Scroll Delta Per Tick Define the scroll wheel speed sent to Unity UI (uGUI) components. The value in this field is a multiplier of the PointerEventData.scrollDelta value.
    Actions Asset An action asset containing all the actions to control the UI. You can choose which actions in the Asset correspond to which UI inputs using the following properties.

    By default, this references a built-in asset named DefaultInputActions, which contains common default actions for driving UI. If you want to set up your own actions, create a custom input action asset and assign it here.

    When you assign a new asset reference to this field in the Inspector, the Editor attempts to automatically map actions to UI inputs based on common naming conventions, and lists the actions underneath the Actions Asset property.

    Cursor Lock Behavior Controls the origin point of UI raycasts when the cursor is locked. By default, the available options are:

    - Outside Screen
    - Screen Center
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)