I
I
Incari Studio
2022.2
Search
⌃K

On Mouse Button Down

Overview

The On Mouse Button Down Node with Object base.
The On Mouse Button Down Node with Screen base.
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: Scene, Prefab.

Attributes

The On Mouse Button Down Node Attributes.

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