# On Mouse Click

## Overview

![The On Mouse Click Node with Object base.](https://4267723012-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOEts3pBau6LMamSYhGZp%2Fuploads%2Fgit-blob-840becf6585fae95bb3441a624011d536cb3711c%2Fnode-on-mouse-click-objbase.png?alt=media)

![The On Mouse Click Node with Screen base.](https://4267723012-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOEts3pBau6LMamSYhGZp%2Fuploads%2Fgit-blob-c86b68b9a8b39eb377058a0e35a7c6a387649a3a%2Fnode-on-mouse-click-evbase.png?alt=media)

**On Mouse Click** is an **Event Listener** **Node** used for executing a **Logic Branch** when there is a mouse click, either on a particular **Object** or anywhere in the **Screen**.

The **Attributes** allow the user to choose which mouse button will trigger the **Event** and whether the `Event Base` is a specific **Object** or the entire **Screen**.

[**Scope**](https://docs.incari.com/incari-studio/2022.2/overview#scopes): **Scene**, **Prefab**.

## Attributes

![The On Mouse Click Node Attributes.](https://4267723012-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOEts3pBau6LMamSYhGZp%2Fuploads%2Fgit-blob-6b27a49dc875ca8ea5c6baad123405063c1f6590%2Fnode-on-mouse-click-attri.png?alt=media)

### Button

| Attribute      | Type          | Description                                                                        |
| -------------- | ------------- | ---------------------------------------------------------------------------------- |
| `Mouse Button` | **Drop-down** | Whether the left, middle, or right button of the mouse will trigger the **Logic**. |

### Event Base

| Attribute    | Type          | Description                                                                                                                   |
| ------------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `Event Base` | **Drop-down** | Whether the **Logic** will be triggered when there is a mouse click on a particular **Object** or anywhere in the **Screen**. |

## Inputs

Note: **Input Sockets** only available when `Event Base` is set to `Object`.

| Attribute       | Type         | Description                                                                        |
| --------------- | ------------ | ---------------------------------------------------------------------------------- |
| `Object ID`     | **ObjectID** | The **Object** in which a click triggers the **Logic Branch**.                     |
| `Subscribe` (►) | **Pulse**    | An **Input Pulse** that needs to be triggered to start listening to the **Event**. |

## Outputs

| Output             | Type         | Description                                                                                                                                                                                      |
| ------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| *Pulse Output* (►) | **Pulse**    | A standard **Output Pulse**, to move onto the next **Node** along the **Logic Branch**, once this **Node** has finished its execution.                                                           |
| `IsLongClick`      | **Bool**     | *True* when the button is pressed longer than usual.                                                                                                                                             |
| `Object ID`        | **ObjectID** | The **Object ID** of the **Object** that was clicked on. If there is no **Object** on that part of the **Screen**, the output is the **Object ID** `00000000-0000-0000-0000-000000000000`.       |
| `Event ID`         | **ObjectID** | The ID of the current **Event**. This can be connected to the [**Unsubscribe Node**](https://docs.incari.com/incari-studio/2022.2/toolbox/events/unsubscribe) to unsubscribe from the **Event**. |

## See Also

* [**Events**](https://docs.incari.com/incari-studio/2022.2/toolbox/events)
* [**Mouse**](https://docs.incari.com/incari-studio/2022.2/toolbox/events/mouse)