How do I disable and enable the input system?

Unity Engine
1

Hello All,

I have the player input moving, he runs and jumps and does all sorts of things, however, I’d like to disable it and enable it at will, for example when I need to prevent player input while a big boss appears and shows off for a few seconds.

I’m looking at this page on the unity docs which says to use PlayerInput.DeactivateInput. However I can’t find a way to use this.

Is it a case of using:
PlayerInput input = GetComponent()
then calling
input.DeactivateInput()?
The site doesn’t say.
The reason I can’t try this at the moment is because my player input script is also called PlayerInput, and I don’t know how to differentiate between the player input class I added to the gameobject, and the Unity PlayerInput that’s added to the class to use the new input system.

Thanks in advance.

2

Hi,
you probably want to deactivate the actionmap that is used for the player movement, i.e. by calling

input.YourActionMap.Disable();
2 Likes
3

Please refer to my comment further below as I made a big mistake years ago when making this comment. I feel like it’s caused a lot of google searches to come up with issue.

2 Likes
4

Thank you. I’ll give that a try.

5

Does this code work if you are using the Legacy input system?

6

Uh no. It’s for the new input system. It’s not relevant at all to the old system.

2 Likes
7

Ok thanks. Any idea how to do it with the old system?

8

You can’t disable the old input system as far as I’m aware. You can only introduce your own system to guard any code that reads input from executing.

1 Like
9

Ya I was thinking of just making another bool around any input code, is that what you mean?

10

Yes, that is what I mean.

Though really I would use a guard-pattern:

private void Update()
{
    if ([GameIsPaused] == true)
    {
        return;
    }
   
    // input reading code
}
1 Like
11

I’ll have to research this, I’ve never used this pattern before! Thank you.

12

Hmm, doesn’t seem to work…
It doesn’t have methods Enable() and Disable(), but does have ActivateInput() and DeactivateInput().

I used DeactivateInput(), but it still returns a warning at PlayerInput input = new PlayerInput();:

13

I very much shorthanded the code, but I believe I made the mistake of saying you can declare a new PlayerInput component when I was trying to convey you can disable the inputactionmap. I was relatively new to the system and completely missed the PlayerInput reference I made.

In truth, it would be more along the lines of (more quick code, haven’t checked it) -

private YourActionMap _actionMap;

void Awake(){
_actionMap = new YourActionMap();
}

void OnEnable(){
_actionMap.Jump.performed += JumpAciton;
_actionMap.Enable();
}

void OnDisable(){
_actionMap.Jump.performed -= JumpAciton;
_actionMap.Disable();
}

This is using the script generated from the input asset.

As for the original purpose of the post, here’s a testing script I used to show how to disable or enable a player input-

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.InputSystem;

public class DEBUGPlayerInput : MonoBehaviour
{
    public PlayerInput _playerInput;

    IEnumerator Start()
    {
        while (true)
        {
            yield return new WaitForSeconds(1f);
            _playerInput.DeactivateInput();
            Debug.Log("Deactivated Input");
            yield return new WaitForSeconds(1f);
            _playerInput.ActivateInput();
            Debug.Log("Activated Input");
        }
    }
}

You were correct in that you need to call DeactivateInput or ActivateInput, you just need to reference the PlayerInput.

I apologize for the general confusion my previous comment probably caused, I didn’t know there were previous comments asking about the code I posted. I’ll change it up a bit to reflect this comment.

1 Like
14

Best method I found to disable the input system is to reference through the ‘InputActionAsset’, then call on your input system you made. From here, you can then reference it in your code to call .Enable() or .Disable().

{7FC52B92-1887-4EC9-8986-7452B963F526}
{7FC52B92-1887-4EC9-8986-7452B963F526}477×442 13.1 KB

1 Like
15

You can do this but on an individual input level as well.
The below should also work with your current Toggle script so long as you have “Player” as an action map and “Move” as an action.

image
image522×150 9.73 KB

public void EnableMovement()
{
   var input = _pInput.actions.FindActionMap("Player").FindAction("Move");
   input.Enable();
}

public void DisableMovement()
{
   var input = _pInput.actions.FindActionMap("Player").FindAction("Move");
   input.Disable();
}
2 Likes