docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Enum InputBinding.DisplayStringOptions

    A set of flags to turn individual default behaviors of ToDisplayString(DisplayStringOptions, InputControl) off.

    Namespace: UnityEngine.InputSystem
    Assembly: Unity.InputSystem.dll
    Syntax
    [Flags]
    public enum InputBinding.DisplayStringOptions

    Fields

    Name Description
    DontIncludeInteractions

    By default, interactions on bindings are included in the resulting display string. For example, a binding to the gamepad's A button that has a "Hold" interaction on it, would come out as "Hold A". This can be suppressed with this option in which case the same setup would come out as just "A".

    DontOmitDevice

    By default device names are omitted from display strings. With this option, they are included instead. For example, "A" will be "A [Gamepad]" instead.

    DontUseShortDisplayNames

    Do not use short names of controls as set up by shortDisplayName and the "shortDisplayName" property in JSON. This will, for example, not use LMB instead of "left Button" on leftButton.

    IgnoreBindingOverrides

    By default, effectivePath is used for generating a display name. Using this option, the display string can be forced to path instead.

    In This Article
    Back to top
    Copyright © 2024 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)