On Mouse Up As Button node

Note

The On Mouse Up As Button node is an Input Manager node. For more information about how to use the Input Manager with Visual Scripting, see Capture user input in an application.

The On Mouse Up As Button node listens for a user to release their mouse button after they click a Collider in your application. It triggers the next node connected to it after the action occurs in the application. It doesn't send or receive any other data.

To trigger the On Mouse Up As Button node, the user must release their mouse button over the same Collider they clicked. If you want the user to trigger the node after they release their mouse button at any location in your application, use the On Mouse Up node instead.

An image of the Graph window. An On Mouse Up As Button node displays with its details in the Graph Inspector.

Fuzzy finder category

The On Mouse Up As Button node is in the Events > Input category in the fuzzy finder.

Inputs

The On Mouse Up As Button node has one input port:

Name Type Description
Target GameObject The GameObject the user must click and release with their mouse button to trigger the node.

Additional node settings

The On Mouse Up As Button node has additional settings. Access these settings from the Graph Inspector:

Name Type Description
Coroutine Toggle Enable Coroutine if you want Visual Scripting to run this node and any of its connected nodes as a coroutine. Coroutine nodes don't execute all their code in a single frame, so they can spread an effect over several frames. Coroutines can also help optimize your code. For more information on coroutines, see the Unity User Manual section on Coroutines.

Outputs

The On Mouse Up As Button node has one output port:

Name Type Description
Trigger Output Trigger The control output port. Make a connection to specify what Visual Scripting should do after the configured Input event occurs in your application.

Example graph usage

In the following example, the On Mouse Up As Button node runs as a coroutine to load a new scene after the user clicks and releases their mouse button over the Target GameObject. The Script Graph loads the scene, makes the graph wait until the scene loads, then sets the loaded scene as the active scene in the application.

An image of the Graph window. An On Mouse Up As Button node has its Target set to This and is set to run as a coroutine. Its Trigger output port connects to the Invoke input port on a Scene Manager Load Scene node. The Load Scene node loads the scene from Scene Build Index 1, with an inline value. Its Exit output port connects to the Enter input port on a Wait Until node. The Wait Until node waits until a Scene Is Loaded node returns True as its Condition input. When Is Loaded returns True, the Wait Until node's Exit output port triggers the Invoke input port on a Scene Manager Get Scene At node. The Get Scene At node gets the scene from Index 1 with an inline value. Its Exit output port connects to the Invoke input port on a Scene Manager Set Active Scene node. The Set Active Scene node takes the Result scene output from the Get Scene At node and changes the active scene in the application.

When the application starts, the active scene contains a plane with three spheres.

An image of the Game view, that displays a simple plane with three red spheres.

After the Script Graph runs, the scene changes to a plane with a single cube.

An image of the Game view, that displays a simple plane with a single red cube.

The following nodes are related or similar to the On Mouse Up As Button node: