Resolved Example code for InputAction.GetBindingDisplayString that returns controlPath doesn't compile

I want to know how to get controlPath of an InputAction, but example code from documentation doesn't work.

Code (CSharp):

1. var action = new InputAction();
2.  
3. action.AddBinding("<Gamepad>/dpad/up", groups: "Gamepad");
4.  
5. // Prints "A", then "Gamepad", then "dpad/up".
6. Debug.Log(action.GetBindingDisplayString(InputBinding.MaskByGroup("Gamepad", out var deviceLayoutNameA, out var controlPathA));
7. Debug.Log(deviceLayoutNameA);
8. Debug.Log(controlPathA);

First of all there's missing parenthesis, second - MaskByGroup returns InputBinding, but we need int bindingIndex here instead.

 

Indeed. Will push a fix for the docs.

You can look up the binding index using

GetBindingIndex

and then pass it to

GetBindingDisplayString

.

Code (CSharp):

1. var bindingIndex = action.GetBindingIndex(group: "Gamepad");
2. var displayString = action.GetBindingDisplayString(bindingIndex, out var _, out var controlPath);

 

action.GetBindingDisplayString(); 

gives the correct text, it works well. As I switch between keyboard and gamepad, I get the correct text. (for eg. SPACE / A)

However, I cannot use

action.GetBindingDisplayString(out var deviceLayoutName, out var controlPath);

.
This override seems not to exist.

This one gives strange results

action.GetBindingDisplayString(action.GetBindingIndex(), out var deviceLayoutName, out var controlPath);

Rather than switching from keyboard to gamepad dynamically, it just switches from the short name to the long name (eg. Shift becomes Left Shift instead of LB for gamepad).

How do I figure out what device/path my current action is on based on the current scheme?

 

I posted a possible (possibly flawed) solution in the other thread:
Show current button for some Action