image/svg+xml
docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License
    Show / Hide Table of Contents
    • Unity​Engine.​Input​System
      • Accelerometer
      • Ambient​Temperature​Sensor
      • Attitude​Sensor
      • Common​Usages
      • Default​Input​Actions
      • Default​Input​Actions.​IPlayer​Actions
      • Default​Input​Actions.​IUIActions
      • Default​Input​Actions.​Player​Actions
      • Default​Input​Actions.​UIActions
      • Gamepad
      • Gravity​Sensor
      • Gyroscope
      • Humidity​Sensor
      • IInput​Action​Collection
      • IInput​Action​Collection2
      • IInput​Interaction
      • IInput​Interaction<TValue>
      • Input​Action
      • Input​Action.​Callback​Context
      • Input​Action​Asset
      • Input​Action​Change
      • Input​Action​Map
      • Input​Action​Phase
      • Input​Action​Property
      • Input​Action​Rebinding​Extensions
      • Input​Action​Rebinding​Extensions.​Rebinding​Operation
      • Input​Action​Reference
      • Input​Action​Setup​Extensions
      • Input​Action​Setup​Extensions.​Binding​Syntax
      • Input​Action​Setup​Extensions.​Composite​Syntax
      • Input​Action​Setup​Extensions.​Control​Scheme​Syntax
      • Input​Action​Type
      • Input​Binding
      • Input​Binding.​Display​String​Options
      • Input​Binding​Composite
      • Input​Binding​Composite<TValue>
      • Input​Binding​Composite​Context
      • Input​Binding​Composite​Context.​Part​Binding
      • Input​Control
      • Input​Control<TValue>
      • Input​Control​Extensions
      • Input​Control​Extensions.​Enumerate
      • Input​Control​Extensions.​Input​Event​Control​Collection
      • Input​Control​Extensions.​Input​Event​Control​Enumerator
      • Input​Control​Layout​Change
      • Input​Control​List<TControl>
      • Input​Control​Path
      • Input​Control​Path.​Human​Readable​String​Options
      • Input​Control​Path.​Parsed​Path​Component
      • Input​Control​Scheme
      • Input​Control​Scheme.​Device​Requirement
      • Input​Control​Scheme.​Match​Result
      • Input​Control​Scheme.​Match​Result.​Match
      • Input​Device
      • Input​Device​Change
      • Input​Extensions
      • Input​Interaction​Context
      • Input​Processor
      • Input​Processor<TValue>
      • Input​Recorder
      • Input​Recorder.​Change
      • Input​Recorder.​Change​Event
      • Input​Remoting
      • Input​Remoting.​Message
      • Input​Remoting.​Message​Type
      • Input​Settings
      • Input​Settings.​Background​Behavior
      • Input​Settings.​Editor​Input​Behavior​In​Play​Mode
      • Input​Settings.​iOSSettings
      • Input​Settings.​Update​Mode
      • Input​System
      • Input​Test​Fixture
      • Input​Test​Fixture.​Action​Constraint
      • Input​Value
      • Joystick
      • Key
      • Keyboard
      • Light​Sensor
      • Linear​Acceleration​Sensor
      • Magnetic​Field​Sensor
      • Mouse
      • Pen
      • Pen​Button
      • Player​Input
      • Player​Input.​Action​Event
      • Player​Input.​Controls​Changed​Event
      • Player​Input.​Device​Lost​Event
      • Player​Input.​Device​Regained​Event
      • Player​Input​Manager
      • Player​Input​Manager.​Player​Joined​Event
      • Player​Input​Manager.​Player​Left​Event
      • Player​Join​Behavior
      • Player​Notifications
      • Pointer
      • Pressure​Sensor
      • Proximity​Sensor
      • Sensor
      • Step​Counter
      • Touch​Phase
      • Touchscreen
      • Tracked​Device
    • Unity​Engine.​Input​System.​Android
      • Android​Accelerometer
      • Android​Ambient​Temperature
      • Android​Gamepad
      • Android​Gamepad​With​Dpad​Axes
      • Android​Gamepad​With​Dpad​Buttons
      • Android​Gravity​Sensor
      • Android​Gyroscope
      • Android​Joystick
      • Android​Light​Sensor
      • Android​Linear​Acceleration​Sensor
      • Android​Magnetic​Field​Sensor
      • Android​Pressure​Sensor
      • Android​Proximity
      • Android​Relative​Humidity
      • Android​Rotation​Vector
      • Android​Step​Counter
      • Dual​Shock4Gamepad​Android
      • Xbox​One​Gamepad​Android
    • Unity​Engine.​Input​System.​Composites
      • Axis​Composite
      • Axis​Composite.​Which​Side​Wins
      • Button​With​One​Modifier
      • Button​With​Two​Modifiers
      • One​Modifier​Composite
      • Two​Modifiers​Composite
      • Vector2Composite
      • Vector2Composite.​Mode
      • Vector3Composite
      • Vector3Composite.​Mode
    • Unity​Engine.​Input​System.​Controls
      • Any​Key​Control
      • Axis​Control
      • Axis​Control.​Clamp
      • Button​Control
      • Discrete​Button​Control
      • Double​Control
      • Dpad​Control
      • Dpad​Control.​Dpad​Axis​Control
      • Integer​Control
      • Key​Control
      • Quaternion​Control
      • Stick​Control
      • Touch​Control
      • Touch​Phase​Control
      • Touch​Press​Control
      • Vector2Control
      • Vector3Control
    • Unity​Engine.​Input​System.​Dual​Shock
      • Dual​Shock3Gamepad​HID
      • Dual​Shock4Gamepad​HID
      • Dual​Shock​Gamepad
      • IDual​Shock​Haptics
    • Unity​Engine.​Input​System.​Editor
      • Input​Control​Path​Editor
      • Input​Control​Picker
      • Input​Control​Picker.​Mode
      • Input​Control​Picker​State
      • Input​Parameter​Editor
      • Input​Parameter​Editor<TObject>
    • Unity​Engine.​Input​System.​Enhanced​Touch
      • Enhanced​Touch​Support
      • Finger
      • Touch
      • Touch​History
      • Touch​Simulation
    • Unity​Engine.​Input​System.​Haptics
      • IDual​Motor​Rumble
      • IHaptics
    • Unity​Engine.​Input​System.​HID
      • HID
      • HID.​Button
      • HID.​Generic​Desktop
      • HID.​HIDCollection​Descriptor
      • HID.​HIDCollection​Type
      • HID.​HIDDevice​Descriptor
      • HID.​HIDDevice​Descriptor​Builder
      • HID.​HIDElement​Descriptor
      • HID.​HIDElement​Flags
      • HID.​HIDReport​Type
      • HID.​Simulation
      • HID.​Usage​Page
      • HIDSupport
      • HIDSupport.​HIDPage​Usage
    • Unity​Engine.​Input​System.​Interactions
      • Hold​Interaction
      • Multi​Tap​Interaction
      • Press​Behavior
      • Press​Interaction
      • Slow​Tap​Interaction
      • Tap​Interaction
    • Unity​Engine.​Input​System.​iOS
      • Dual​Shock4Gampadi​OS
      • i​OSGame​Controller
      • Privacy​Data​Usage
      • Xbox​One​Gampadi​OS
    • Unity​Engine.​Input​System.​iOS.​Low​Level
      • i​OSStep​Counter
      • Motion​Authorization​Status
    • Unity​Engine.​Input​System.​Layouts
      • Input​Control​Attribute
      • Input​Control​Layout
      • Input​Control​Layout.​Builder
      • Input​Control​Layout.​Builder.​Control​Builder
      • Input​Control​Layout.​Control​Item
      • Input​Control​Layout.​Layout​Not​Found​Exception
      • Input​Control​Layout​Attribute
      • Input​Device​Description
      • Input​Device​Find​Control​Layout​Delegate
      • Input​Device​Matcher
    • Unity​Engine.​Input​System.​Low​Level
      • Delta​State​Event
      • Device​Configuration​Event
      • Device​Remove​Event
      • Device​Reset​Event
      • Disable​Device​Command
      • Enable​Device​Command
      • Enable​IMEComposition​Command
      • Gamepad​Button
      • Gamepad​State
      • IInput​Device​Command​Info
      • IInput​Event​Type​Info
      • IInput​State​Callback​Receiver
      • IInput​State​Change​Monitor
      • IInput​State​Type​Info
      • IInput​Update​Callback​Receiver
      • IMEComposition​Event
      • IMEComposition​String
      • Initiate​User​Account​Pairing​Command
      • Initiate​User​Account​Pairing​Command.​Result
      • Input​Device​Command
      • Input​Device​Command​Delegate
      • Input​Device​Execute​Command​Delegate
      • Input​Event
      • Input​Event​Buffer
      • Input​Event​Listener
      • Input​Event​Ptr
      • Input​Event​Trace
      • Input​Event​Trace.​Device​Info
      • Input​Event​Trace.​Replay​Controller
      • Input​Metrics
      • Input​State
      • Input​State​Block
      • Input​State​History
      • Input​State​History.​Record
      • Input​State​History.​Record​Header
      • Input​State​History<TValue>
      • Input​State​History<TValue>.​Record
      • Input​Update​Type
      • IText​Input​Receiver
      • Keyboard​State
      • Mouse​Button
      • Mouse​State
      • Pen​State
      • Query​Can​Run​In​Background
      • Query​Dimensions​Command
      • Query​Enabled​State​Command
      • Query​Keyboard​Layout​Command
      • Query​Key​Name​Command
      • Query​Paired​User​Account​Command
      • Query​Paired​User​Account​Command.​Result
      • Request​Reset​Command
      • Request​Sync​Command
      • Set​IMECursor​Position​Command
      • Set​Sampling​Frequency​Command
      • State​Event
      • Text​Event
      • Touch​State
    • Unity​Engine.​Input​System.​On​Screen
      • On​Screen​Button
      • On​Screen​Control
      • On​Screen​Stick
    • Unity​Engine.​Input​System.​Processors
      • Axis​Deadzone​Processor
      • Clamp​Processor
      • Editor​Window​Space​Processor
      • Invert​Processor
      • Invert​Vector2Processor
      • Invert​Vector3Processor
      • Normalize​Processor
      • Normalize​Vector2Processor
      • Normalize​Vector3Processor
      • Scale​Processor
      • Scale​Vector2Processor
      • Scale​Vector3Processor
      • Stick​Deadzone​Processor
    • Unity​Engine.​Input​System.​Samples
      • Input​Action​Visualizer
      • Input​Action​Visualizer.​Visualization
      • Input​Control​Visualizer
      • Input​Control​Visualizer.​Mode
      • Input​Visualizer
    • Unity​Engine.​Input​System.​Switch
      • Switch​Pro​Controller​HID
    • Unity​Engine.​Input​System.​UI
      • Extended​Pointer​Event​Data
      • Input​System​UIInput​Module
      • Multiplayer​Event​System
      • Tracked​Device​Raycaster
      • UIPointer​Behavior
      • UIPointer​Type
      • Virtual​Mouse​Input
      • Virtual​Mouse​Input.​Cursor​Mode
    • Unity​Engine.​Input​System.​Users
      • Input​User
      • Input​User.​Control​Scheme​Change​Syntax
      • Input​User​Account​Handle
      • Input​User​Change
      • Input​User​Pairing​Options
    • Unity​Engine.​Input​System.​Utilities
      • Display​String​Format​Attribute
      • Four​CC
      • Input​Action​Trace
      • Input​Action​Trace.​Action​Event​Ptr
      • Interned​String
      • Name​And​Parameters
      • Named​Value
      • Observable
      • Primitive​Value
      • Read​Only​Array<TValue>
      • Read​Only​Array<TValue>.​Enumerator
      • Read​Only​Array​Extensions
      • Vector2Magnitude​Comparer
      • Vector3Magnitude​Comparer
    • Unity​Engine.​Input​System.​Web​GL
      • Web​GLGamepad
      • Web​GLJoystick
    • Unity​Engine.​Input​System.​XInput
      • IXbox​One​Rumble
      • Xbox​Gamepad​Mac​OS
      • Xbox​One​Gampad​Mac​OSWireless
      • XInput​Controller
      • XInput​Controller.​Device​Flags
      • XInput​Controller.​Device​Sub​Type
    • Unity​Engine.​Input​System.​XR
      • Bone
      • Bone​Control
      • Eyes
      • Eyes​Control
      • Feature​Type
      • Pose​Control
      • Pose​State
      • Tracked​Pose​Driver
      • Tracked​Pose​Driver.​Tracking​Type
      • Tracked​Pose​Driver.​Update​Type
      • Usage​Hint
      • XRController
      • XRController​With​Rumble
      • XRDevice​Descriptor
      • XRFeature​Descriptor
      • XRHMD
      • XRUtilities
    • Unity​Engine.​Input​System.​XR.​Haptics
      • Buffered​Rumble
      • Get​Current​Haptic​State​Command
      • Get​Haptic​Capabilities​Command
      • Haptic​Capabilities
      • Haptic​State
      • Send​Buffered​Haptic​Command
      • Send​Haptic​Impulse​Command
    • Scripting API
    • Unity​Engine.​Input​System.​Users
    • Input​User​Change

    Enum InputUserChange

    Indicates what type of change related to an InputUser occurred.

    Namespace: UnityEngine.InputSystem.Users
    Syntax
    public enum InputUserChange : int

    Fields

    Name Description Value
    Added

    A new user was added to the system.

    0
    Removed

    An existing user was removed from the user.

    1
    DevicePaired

    A user has had a device assigned to it.

    2
    DeviceUnpaired

    A user has had a device removed from it.

    3
    DeviceLost

    A device was removed while paired to the user.

    4
    DeviceRegained

    A device that was previously lost (DeviceLost) was regained by the user.

    5
    AccountChanged 6
    AccountNameChanged 7
    AccountSelectionInProgress 8
    AccountSelectionCanceled 9
    AccountSelectionComplete 10
    ControlSchemeChanged

    A user switched to a different control scheme.

    11
    ControlsChanged

    A user's bound controls have changed, either because the bindings of the user have changed (for example, due to an override applied with ApplyBindingOverride(InputAction, InputBinding)) or because the controls themselves may have changed configuration (every time the device of the controls receives an DeviceConfigurationEvent; for example, when the current keyboard layout on a Keyboard changes which in turn modifies the displayNames of the keys on the keyboard).

    12
    In This Article
    • Fields
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023