> For the complete documentation index, see [llms.txt](https://scripting.breeze.rip/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://scripting.breeze.rip/api/events/mouseclickedevent.md).

# MouseClickedEvent

Gets called when the mouse is clicked.

### Extends

* [`CancellableEvent`](/api/breeze/event/cancellableevent.md)

### Methods

#### cancel()

> **cancel**(): `void`

Cancels the event.

**Returns**

`void`

**Inherited from**

[`CancellableEvent`](/api/breeze/event/cancellableevent.md).[`cancel`](/api/breeze/event/cancellableevent.md#cancel)

***

#### getButton()

> **getButton**(): `string`

Gets the button that was clicked.

**Returns**

`string`

the type of MouseClickedEvent can be: LEFT, RIGHT, or HOLD\_LEFT

***

#### isCancelled()

> **isCancelled**(): `boolean`

**Returns**

`boolean`

If the event is cancelled or not.

**Inherited from**

[`CancellableEvent`](/api/breeze/event/cancellableevent.md).[`isCancelled`](/api/breeze/event/cancellableevent.md#iscancelled)