Enum InputBinding.DisplayStringOptions

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

Namespace: UnityEngine.InputSystem
Syntax
[Flags]
public enum DisplayStringOptions

Fields

Name Description Value
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.

 1
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.

 2
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".

 4
IgnoreBindingOverrides

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

 8