PerformInteractiveRebinding not working

Unity Engine
,
1

Hello,

I have an InputAction File with my Keybindings.
Then I have a InputActionReference binded to an Action I want to override.

When I click the button I want to be able to perform an InteractiveRebinding but it is not working

 public void StartInteractiveRebind()
    {
        var rebindOperation = m_Action.action.PerformInteractiveRebinding()
            // To avoid accidental input from mouse motion
            .WithControlsExcluding("Mouse")
            .WithCancelingThrough("<Keyboard>/escape")
            .OnMatchWaitForAnother(0.2f)
            .Start();

    Debug.Log("finished");

    }

but the Log message is beeing sent at the same time when I press the button so the Performinteractive is over before I even can enter a new key for the action

Regards

1 Like
2

First of all I am sooo happy Iā€™ve stumbled on your post. I have been trying to understand the provided examples for days now and your not quite working code was exactly what I needed. I managed to do everything I needed in minutes!

To show my gratitude I would like to offer you some shaky explanation written by a guy with one year of c# experience.
Anyway you have probably figured it out yourself by now, but perhaps others are interested. Anyway here it goes:

First problem with your code (and probably the origin for your debug needs) you donā€™t deactivate your action while rebinding it. An action cannot be rebound while it is in use, since it would cause uncertainty.

It probably threw you a similar error to this:

InvalidOperationException: Cannot rebind action 'Player/Jump[/Keyboard/space]' while it is enabled
UnityEngine.InputSystem.InputActionRebindingExtensions+RebindingOperation.WithAction (UnityEngine.InputSystem.InputAction action) (at wherever your class is)

Solution is easy, just disable it before the rebinding with:
m_Action.action.Disable();

and re enable it with:
m_Action.action.Enable();

Edit:
You can detect when the rebinding is complete with:
if(rebindOperation.completed)

Now the second question. Why dose your Debug.Log() trigger before completion. I donā€™t have a nice answer, but in my limited understanding it boils down to the following:
The command isnā€™t really a step like int i=1+1; but more like a MonoBehaviour similar to Invoke(someFunction, someTimeLater); that triggers every once in a while and checks for inputs that satisfy the parameters.
Basically you mistake the rebind being complete when in fact it is still running (or already legitimately completed).

Since I have a similar base code to you I would like to use this chance to post a working script, that might use some optimization regarding the reactivation of the action. (btw. dose that ā€œm_ā€ before Action mean something? cause I just use Action as a public variable)

using UnityEngine;
using UnityEngine.InputSystem;

public class RebindScript : MonoBehaviour
{
    public InputActionReference Action;
    private InputActionRebindingExtensions.RebindingOperation rebindOperation; // this should be "optimised", since doing updates every frame is inefficient

    void Update()
    {
        if (rebindOperation != null)
            if (rebindOperation.completed)
            {
                Action.action.Enable();// after this you can use the new key
                Debug.Log("finished");
            }
    }

    public void StartInteractiveRebind()
    {
        Action.action.Disable(); // critical before rebind!!!
        rebindOperation = Action.action.PerformInteractiveRebinding()
            .WithControlsExcluding("Mouse")
            .WithCancelingThrough("<Keyboard>/escape")
            .OnMatchWaitForAnother(0.2f)
            .Start();
    }

}

Before I forget this script apparently eats alternative action bindings, so beware! If you have jump on ā€˜spaceā€™ and ā€˜wā€™ for example after this procedure you will only keep your new binding and will have to reload to have both back!

I would like to apologize if the formatting is weird I am new to forums in general.

Cordially the all consuming void.

4 Likes
3

Thank you for the answer, I cant verify if you solution would have helped, because I have solved it myself by then.
but for documentation my error was that PerformInteractiveRebinding needed an Bindingindex

so changing my code to

 public void StartInteractiveRebind()
    {
     
 var m_RebindOperation = actionref.action.PerformInteractiveRebinding(1)
            // To avoid accidental input from mouse motion
            .WithControlsExcluding("Mouse")
            .WithCancelingThrough("<Keyboard>/escape")
            .OnMatchWaitForAnother(0.2f)
            .Start().OnCancel(op =>
            {
                CleanUp();
                Debug.Log("cancel");
                RebindOverlay.SetActive(false);
                KeybindMenu.SetActive(true);

            }).OnComplete(op =>
            {
                SetPref(prefs, op.action.GetBindingDisplayString(1));
                textmesh.text = op.action.GetBindingDisplayString(1).ToUpper();
                StoreControlOverrides();
                Debug.Log("saved1");
                RebindOverlay.SetActive(false);
                KeybindMenu.SetActive(true);
                CleanUp();
            });

        RebindOverlay.SetActive(true);
        KeybindMenu.SetActive(false);
    Debug.Log("finished");
    }

worked for me , keep in mind I also added an rebind overlay so that the user knows that he is rebinding

1 Like
4

I have noticed that the addition of the binding index resolves the issue I mentioned in the end of my reply. So putting one there is definitely recommended. Good to know!

Also is there a reason you set Index 1 and not index 0 ? If you have only one binding preset that would cause an error (binding index out of range for action). If you have two preset it wouldnā€™t cause an issue, but doing that would leave an ā€œoriginalā€ binding. Probably reading too much into thisā€¦

Anyway your solution now looks a lot more like the recommended one in the example files. That must mean itā€™s good.

Good luck with your project!
Cordially the talkative void

1 Like