docs.unity3d.com
    Show / Hide Table of Contents

    On Input System Event Vector 2 node

    Note

    The On Input System Event Vector 2 node is an Input System package node. For more information about how to use the Input System package in Visual Scripting, see Capture user input in an application.

    The On Input System Event Vector 2 node listens for a specific Input Action from a Player Input component. The node can output two values as a Vector 2.

    Use this node when you want to read input and return two values, such as a joystick or mouse position.

    An image of the Graph window. An On Input System Event Vector 2 node displays with its details in the Graph Inspector.

    Fuzzy finder category

    The On Input System Event Vector 2 node is in the Events > Input category in the fuzzy finder.

    Inputs

    The On Input System Event Vector 2 node has the following input ports:

    Name Type Description
    Target Player Input The Player Input component that Visual Scripting uses to display a list of input actions. The default is This, which is the Player Input component attached to the GameObject where Visual Scripting runs the Script Graph. You can also connect a node that outputs a Player Input component.
    Input Action Input Action An input action. Use the dropdown to select an input action from the Player Input component specified in Player Input, or connect a node that outputs an input action.

    Controls

    The On Input System Event Vector 2 node has the following controls:

    Name Type Description
    Input Action Change Type Input Action Change Option Set an Input Action Change Type to choose the interaction type that triggers the node.
    On Pressed The node triggers when a user presses the button from the selected Input Action input asset.
    On Hold The node triggers when a user holds the button from the selected Input Action input asset.
    On Released The node triggers when a user releases the button from the selected Input Action input asset.

    You can also set this control from the Graph Inspector.

    Additional node settings

    The On Input System Event Vector 2 node has additional settings. Access these settings from the Graph Inspector:

    Name Type Description
    Coroutine Toggle Enable Coroutine if you want Visual Scripting to run this node and any of its connected nodes as a coroutine. Coroutine nodes don't execute all their code in a single frame, so they can spread an effect over several frames. Coroutines can also help optimize your code. For more information on coroutines, see the Unity User Manual section on Coroutines.

    Outputs

    The On Input System Event Vector 2 node has the following output ports:

    Name Type Description
    Trigger Output Trigger The control output port. Make a connection to specify what Visual Scripting does after the configured Player Input event, such as a button press, occurs in the application.
    Vector 2 Value Vector 2 A Vector 2 output port.
    Visual Scripting uses your chosen Input Action and its configuration in your Input Actions asset to determine the Vector 2 value returned by this port. See the Example graph usage section for an example.
    For more information about how to configure Input Action settings and use an Input Action asset, see Input Action Assets in the Input System package documentation.

    Example graph usage

    In the following example, an On Input System Event Vector 2 node uses the bindings assigned to the Move Input Action. When a user presses a button from the Move binding, Visual Scripting takes the Vector 2 value it receives from the Input System and sends it as an input to the Transform Set Position node's Value input port. The Vector 2 value changes the position of the GameObject associated with the Target transform.

    An image of the Graph Editor, that displays the Script Graph described above. An On Input System Event Vector 2 node sends a Vector 2 value to the Value input port on a Transform Set Position node.

    For this example, Move uses the W, A, S, and D keys. The GameObject moves up in the scene when the user presses W, moves down when the user presses S, and moves left or right when the user presses A or D.

    Related nodes

    The following nodes are related or similar to the On Input System Event Vector 2 node:

    • On Input System Event Button node
    • On Input System Event Float node
    In This Article
    • Fuzzy finder category
    • Inputs
    • Controls
    • Additional node settings
    • Outputs
    • Example graph usage
    • Related nodes
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023