Singularity/Library/PackageCache/com.unity.visualscripting@1.../Documentation~/vs-nodes-events-on-mouse-ex...
2024-05-06 11:45:45 -07:00

3.5 KiB

On Mouse Exit node

Note

The On Mouse Exit [!includenodes-note-manual]

The On Mouse Exit node listens for the user's mouse pointer location to exit the Collider of a specified GameObject. When the mouse exits the Collider or GUI element, the node triggers the next node connected to it. It doesn't send or receive any other data.

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

Fuzzy finder category

The On Mouse Exit node is in the Events > Input category in the fuzzy finder.

Inputs

The On Mouse Exit [!includenodes-single-input]

Name Type Description
Target GameObject The GameObject with the Collider that triggers the On Mouse Exit node.

Additional node settings

The On Mouse Exit [!includenodes-additional-settings]

[!include[nodes-coroutine](./snippets/nodes-coroutine.md)]
Name Type Description

Outputs

The On Mouse Exit [!includenodes-single-output]

[!include[nodes-input-output-trigger](./snippets/input-manager/nodes-input-output-trigger.md)]
Name Type Description

Example graph usage

In the following example, continued from the example from the On Mouse Enter node, the On Mouse Exit node triggers a Destroy GameObject node when the user's mouse exits the Collider on the Script Machine's GameObject. The Destroy GameObject node destroys the GameObject assigned to the Spotlight Scene variable. The GameObject was created and assigned to the variable elsewhere in the graph.

An image of the Graph window. An On Mouse Exit node's Trigger output port connects to the Invoke input port on a Destroy GameObject node. A Get Variable node sends the value of the Spotlight Scene variable to the Destroy GameObject node to tell it which GameObject to destroy. Above the three nodes, there is part of the example graph from the On Mouse Enter node example, where an Instantiate GameObject node assigns its new GameObject as the value for the Spotlight Scene variable with a Set Variable node.

When the user's mouse leaves the Collider, the Target GameObject no longer has a spotlight.

An image of the Game view, that displays a simple scene with a plane and a cube GameObject.

[!includenodes-related] On Mouse Exit node: