On Input System Event Float node

Note

The On Input System Event Float 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 Float node lists for a specific Input Action from a Player Input component. The node can output a single float value.

Use this node when you want to read user input and return a single value, such as an axis value or input from a trigger on a controller.

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

Fuzzy finder category

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

Inputs

The On Input System Event Float 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 Float 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 Float node has additional settings. Access these settings from the Graph Inspector:

[!includenodes-coroutine

Outputs

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

[!include[nodes-input-system-output-trigger-port](./snippets/input-system/nodes-input-system-output-trigger-port.md)]

Name	Type	Description
Float Value	Float	A float output port. Visual Scripting uses your chosen Input Action and its configuration in your Input Actions asset to determine the float 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 Float node uses the bindings assigned to the Lift Input Action. When a user presses any key from the Lift binding, Visual Scripting takes the float value it receives from the Input System and sends it as an input to the Vector 3 Create node's Y input port. At the same time, Visual Scripting triggers the Transform Set Position node and uses the output from the Vector 3 Create node to set a new position for the Script Machine's GameObject.

An image that displays the Graph Editor. An On Input System Event Float node has its float output port connected to a Vector 3 Create node, and its output control port connected to a Transform Set Position node.

For this example, Lift uses a Right Trigger from a Gamepad input device as a binding. When a user presses the Right Trigger, the Y value of the GameObject's transform increases, which makes the GameObject move upwards in the scene.

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