Firstborn/Library/PackageCache/com.unity.visualscripting@1.7.8/Documentation~/vs-nodes-events-on-button-input.md

# On Button Input node

> [!NOTE]
> The On Button Input [!include[nodes-note-manual](./snippets/input-manager/nodes-note-manual.md)]

The On Button Input node listens for a specified action on a virtual button from your Input Manager configuration. [!include[nodes-desc-end](./snippets/input-manager/nodes-desc-end.md)]

![An image of the Graph window. An On Button Input node displays with its details in the Graph Inspector.](images/vs-nodes-events-on-button-input-node.png)

## Fuzzy finder category 

The On Button Input node is in the **Events** > **Input** category in the fuzzy finder. 

## Inputs 

The On Button Input [!include[nodes-inputs](./snippets/nodes-inputs.md)] 

<table>
<thead>
<tr>
<th><strong>Name</strong></th>
<th><strong>Type</strong></th>
<th colspan="2"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Name</strong></td>
<td>String</td>
<td colspan="2">The name of the button the node listens to for an Input event, as it appears in the Input Manager.</td>
</tr>
<tr>
<td rowspan="4"><strong>Action</strong></td>
<td rowspan="4">Press State</td>
<td colspan="2">The specific press state of the button that the node listens for.</td>
</tr>
<tr>
<td><strong>Hold</strong></td>
<td>The user holds down the button.</td>
</tr>
<tr>
<td><strong>Down</strong></td>
<td>The user presses the button.</td>
</tr>
<tr>
<td><strong>Up</strong></td>
<td>The user releases the button.</td>
</tr>
</tbody>
</table>


## Additional node settings 

The On Button Input [!include[nodes-additional-settings](./snippets/nodes-additional-settings.md)]

<table>
<thead>
<tr>
<th><strong>Name</strong></th>
<th><strong>Type</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
[!include[nodes-coroutine](./snippets/nodes-coroutine.md)]
</tbody>
</table>

## Outputs

The On Button Input [!include[nodes-single-output](./snippets/nodes-single-output.md)]

<table>
<thead>
<tr>
<th><strong>Name</strong></th>
<th><strong>Type</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
[!include[nodes-input-output-trigger](./snippets/input-manager/nodes-input-output-trigger.md)]
</tbody>
</table>

## Example graph usage 

In the following example, the On Button Input node listens for the user to press the button or key assigned to the **Jump** axes in the Input Manager. When the user presses the button, the On Button Input node triggers the Rigidbody Add Force node, which adds an **Impulse** Force to the Rigidbody's **Y** axis:

![An image of the Graph window. An On Button Input node uses an inline value of Jump for its Name input port. Its Action Input port is set to Down. Its Trigger output port connects to the Invoke input port on a Rigidbody Add Force node. The Rigidbody Add Force node uses an inline value of This for its Target, an inline value of 4 for its Y, and has its Mode set to Impulse.](images/vs-nodes-events-on-button-input-example.png)

The Add Force node makes the **Target** Rigidbody lift into the air. 

![An image of the Game view. Three red spheres are on top of a grey plane, with the middle sphere lifted into the air.](images/vs-nodes-events-on-button-input-example-2.png)


## Related nodes 

[!include[nodes-related](./snippets/nodes-related.md)] to the On Button Input node:

- [On Keyboard Input node](vs-nodes-events-on-keyboard-input.md)
- [On Mouse Down node](vs-nodes-events-on-mouse-down.md)
- [On Mouse Drag node](vs-nodes-events-on-mouse-drag.md)
- [On Mouse Enter node](vs-nodes-events-on-mouse-enter.md)
- [On Mouse Exit node](vs-nodes-events-on-mouse-exit.md)
- [On Mouse Input node](vs-nodes-events-on-mouse-input.md)
- [On Mouse Over node](vs-nodes-events-on-mouse-over.md)
- [On Mouse Up node](vs-nodes-events-on-mouse-up.md)
- [On Mouse Up As Button node](vs-nodes-events-on-mouse-up-button.md)