# On Mouse Button Down

## Overview

![The On Mouse Button Down Node with Object Base and Left Button.](https://1553081948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU990HLHWA30dTfELtDUK%2Fuploads%2Fgit-blob-b969ef23ef23e7969e5648bcfd0be5ee3115a774%2Fonmousebuttondownnode20241.png?alt=media)

![The On Mouse Button Down Node with Screen Base and Left Button.](https://1553081948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU990HLHWA30dTfELtDUK%2Fuploads%2Fgit-blob-d787a195cb1f440ae8d0dd7251d5d19f8816fe80%2Fonmousebuttondownnode20241screen.png?alt=media)

**On Mouse Button Down** is an **Event Listener** **Node** used for executing a **Logic Branch** when a mouse button is pressed, 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/overview#scopes): **Scene**, **Prefab**.

## Attributes

![The On Mouse Button Down Node Attributes.](https://1553081948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU990HLHWA30dTfELtDUK%2Fuploads%2Fgit-blob-2a7bb309fb51b6a69751e092d790df5ef7d01043%2Fonmousebuttondownattributes_new1.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 the mouse button is pressed on a particular **Object** or anywhere in the **Screen**. |

## Inputs

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

| Input           | Type         | Description                                                                        |
| --------------- | ------------ | ---------------------------------------------------------------------------------- |
| `Object ID`     | **ObjectID** | The **Object** in which pressing a button 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.                                                                    |
| `Object ID`        | **ObjectID** | The **Object ID** of the **Object** where the mouse button was pressed. If there is no **Object** on that part of the **Screen**, the output is the **Object ID** `00000000-0000-0000-0000-000000000000`. |

## See Also

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.incari.com/incari-studio/toolbox/events/mouse/on-mouse-button-down.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.