Singularity/Library/PackageCache/com.unity.visualscripting@1.../Documentation~/vs-capturing-player-inputs-...
2024-05-06 11:45:45 -07:00

4.9 KiB

Capture input with the Input Manager

Note

You must configure your Project Settings to use the Input Manager with Visual Scripting. For more information, see Input Manager prerequisites.

To create a basic Script Graph that uses the Input Manager to capture input:

  1. Open or create a Script Graph attached to the GameObject that you want your users to move.

  2. If there isn't an On Update or similar Event node in your graph:

    1. [!include[open-fuzzy-finder](./snippets/vs-open-fuzzy-finder.md)]

    2. Go to Events > Lifecycle, or enter On Update in the search field.

    3. Select the On Update Event node to add it to the graph.

  3. [!include[open-fuzzy-finder](./snippets/vs-open-fuzzy-finder.md)]

  4. TIP

    If you right-click and the context menu appears, select Add Node to open the fuzzy finder.

  5. Go to Codebase > Unity Engine > Input, or enter Get Axis in the search field.

  6. Select Get Axis (Axis Name) to add the Get Axis node to the graph.

  7. Repeat Steps 3 through 5 to create a second Get Axis (Axis Name) node.

  8. On the first Get Axis node, in the Axis Name input field, enter Horizontal.

  9. On the second Get Axis node, in the Axis Name input field, enter Vertical.

  10. NOTE

    If an Axis Name doesn't match the name in the Input Manager's Project Settings, Visual Scripting displays an error in the Graph Inspector. When you enter Play mode, the Unity Editor also displays an error in the Console window.

  11. [!include[open-fuzzy-finder](./snippets/vs-open-fuzzy-finder.md)]

  12. Go to Codebase > Unity Engine > Transform or search for Translate.

  13. Select Translate (X, Y, Z) to add a Translate node to the graph.

  14. Select the Result float output port on the Horizontal Get Axis node.

  15. Make a connection to the X input port on the Translate node.

  16. Select the Result float output port on the Vertical Get Axis node.

  17. Make a connection to the Z input port on the Translate node.
    The finished graph looks similar to the following image:

  18. An image of the Graph window, that displays the final result of a simple input capture graph using the Input Manager. An On Update node connects to the Trigger input port on a Transform Translate node. The Result port on an Input Get Axis node with an Axis Name of Horizontal connects to the X input port on the Translate node. The Result port on another Input Get Axis node with an Axis Name of Vertical connects to the Z input port.

  19. To enter Play mode, select Play from the Unity Editor's Toolbar.

  20. While in the Game view, press a key mapped as a Negative Button or Positive Button from the Input Manager's virtual axes.

The GameObject moves along the X or Z axis in the Game view, based on the key pressed and the Input Manager Project Settings.

Additional resources