docs.unity3d.com
    Show / Hide Table of Contents

    Enum InputUserPairingOptions

    Options to modify the behavior on PerformPairingWithDevice(InputDevice, InputUser, InputUserPairingOptions).

    Namespace: UnityEngine.InputSystem.Users
    Syntax
    [Flags]
    public enum InputUserPairingOptions

    Fields

    Name Description Value
    None

    Default behavior.


    0
    ForcePlatformUserAccountSelection

    Even if the device is already paired to a user account at the platform level, force the user to select an account.


    This is only supported on Xbox and Switch, at the moment.

    On PS4, this is ignored as account pairing is under system control. If the user wants to switch accounts, he/she does so by pressing the PS4 button on the controller.

    On Xbox, this option will bring up the account picker even if the device is already paired to a user. This behavior is useful to allow the player to change accounts.

    On platforms other than Xbox and Switch, this option is ignored.

    1
    ForceNoPlatformUserAccountSelection

    Suppress user account selection when supported at the platform level and a device is not currently paired to a user account.


    On Xbox, if a device that does not currently have a user account logged in on it is paired to an InputUser, no account picker will come up and the device will be used without an associated user account.

    On Switch, this prevents the user management applet from coming up.

    2
    UnpairCurrentDevicesFromUser

    If the user already has paired devices, unpair them first.


    8
    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