Unity’s “New Input System”

Setup

Basics

Workflows

Directly Reading Device State

using UnityEngine;
using UnityEngine.InputSystem;
public class MyPlayerScript : MonoBehaviour {
    void Update() {
        var gamepad = Gamepad.current;
        if (gamepad == null) return; // No gamepad connected.

        if (gamepad.rightTrigger.wasPressedThisFrame) {
            // 'Use' code here
        }

        Vector2 move = gamepad.leftStick.ReadValue();
        // 'Move' code here
    }
}

void Update()
    {
        var pen = Pen.current;
        if (pen == null) return;
        
        Debug.Log($"{pen.position.ReadValue()} > {pen.pressure.ReadValue()}");
    }

Embedded Actions

using UnityEngine;
using UnityEngine.InputSystem;

public class ExampleScript : MonoBehaviour {
    public InputAction move;
    public InputAction jump;
}

using UnityEngine;
using UnityEngine.InputSystem;

// Using embedded actions with callbacks or reading values each frame.

public class ExampleScript : MonoBehaviour {
    // these embedded actions are configurable in the inspector:
    public InputAction moveAction;
    public InputAction jumpAction;

    public void Awake() {
        // assign a callback for the "jump" action.
        jumpAction.performed += ctx => { OnJump(ctx); };
    }

    public void Update() {
        // read the value for the "move" action each frame.
        Vector2 moveAmount = moveAction.ReadValue<Vector2>();
    }

    public void OnJump(InputAction.CallbackContext context) {
        // jump code goes here.
    }

    // the actions must be enabled and disabled
    // when the GameObject is enabled or disabled

    public void OnEnable() {
        moveAction.Enable();
        jumpAction.Enable();
    }

    public void OnDisable() {
        moveAction.Disable();
        jumpAction.Disable();
    }
}

Actions Asset

Test

• Create Input Actions asset

• Edit Asset

• Add new Control Scheme “Keyboard” and add “Keyboard” as a requirement

• Add new Control Scheme “XBox Controller” and add “XBox Controller” as a requirement

• Set up some stuf

• Check “Generate C# Class” on the Input Action Asset

• Option 1: Make a test script and sign up to stuff directly
• Use the generated C# class

void Start() {
    var input = new BoxControls(); // instantiate the generated class
    input.Move.Enable(); // IMPORTANT! ActionMaps are off by default, so you need to enable the ones you want to use!
    
		input.Move.Forward.performed += ForwardOnPerformed; 
	  input.Move.Forward.canceled += ForwardOnCanceled;
 }

• get a value and use it

private void ForwardOnPerformed( InputAction.CallbackContext obj ) {
    Debug.Log( "Forward" );
    _move = obj.ReadValue<float>();
 }

• then use the value(s) you get to move stuff around

• Option 2: Generated class + Interface 🏆 ← Best appraoch
• Callbacks via auto-generated Interface + SetCallbacks()

public class SpaceshipControl : MonoBehaviour, SpaceshipInput.IPlayerActions { ]
	// IPlayerActions was auto-generated for my "Player" ActionMap - yours will be called differently and you might have multiple
	// Let Rider auto-generate the Callback functions for you

	private void Start() {
		SpaceshipInput input = new SpaceshipInput(); // instantiate the auto-generated class
		input.Player.Enable(); // ENABLE the ActionMap
		input.Player.SetCallbacks( this ); // Sign us up for callbacks!
	}

	public void OnBoost( InputAction.CallbackContext context ) {
		Debug.Log( $"Boost: {context.ReadValue<float>()} {context.ReadValueAsButton()}"  );
	}
}

• Option 2: PlayerInput component



• Set it to Invoke Unity Events and set it up to call a function you make

public void SetMove( InputAction.CallbackContext obj  ) {
   _move = obj.ReadValue<float>();
}

Local Multiplayer

• Be aware that Send Messages and Broadcast Messages require different functions than the generated class + Interface approach from above. (InputValue argument instead of CallbackContext)

public void OnBoost( InputValue value ) {
	m_BoostFactor = value.Get<float>();
}

• Invoke Unity Events uses the same events as the generated class + Interface approach from above, but you need to assign them each manually (unfold each ActionMap)

public void OnBoost( InputAction.CallbackContext context ) {
	m_BoostFactor = context.ReadValue<float>();
}

Interactions

Processors

Layouts

UI Support