Enum InputUserChange
Indicates what type of change related to an InputUser occurred.
Namespace: UnityEngine.InputSystem.Users
Syntax
public enum InputUserChange
Fields
Name | Description | Value |
---|---|---|
Added | A new user was added to the system. |
0 |
Removed | An existing user was removed from the user. InputUsers are only removed when explicitly requested (UnpairDevicesAndRemoveUser()). |
1 |
DevicePaired | A user has had a device assigned to it. |
2 |
DeviceUnpaired | A user has had a device removed from it. This is different from DeviceLost in that the removal is intentional. DeviceLost instead indicates that the device was removed due to causes outside of the control of the application (such as battery loss) whereas DeviceUnpaired indicates the device was removed from the user under the control of the application itself. |
3 |
DeviceLost | A device was removed while paired to the user. This scenario happens on battery loss, for example. Note that there is still a DevicePaired change sent when the device is subsequently removed from the user. |
4 |
DeviceRegained | A device that was previously lost (DeviceLost) was regained by the user. This can happen, for example, when a gamepad runs out of battery and is then plugged in by wire. Note that a device may be permanently lost and instead be replaced by a different device. |
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 |