Souichirou/Singularity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Singularity/Library/PackageCache/com.unity.visualscripting@1.../Documentation~/vs-nodes-events-on-mouse-en...
2024-05-06 11:45:45 -07:00

3.7 KiB
Raw Permalink Blame History

On Mouse Enter node

Note

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

The On Mouse Enter node listens for the user's mouse pointer location to enter the Collider of a specified GameObject. When the mouse enters 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 Enter node displays with its details in the Graph Inspector.

Fuzzy finder category

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

Inputs

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

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

Additional node settings

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

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

Outputs

The On Mouse Enter [!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, the On Mouse Enter node triggers the Instantiate GameObject node when the user's mouse enters the Collider on the Script Machine's GameObject. The Instantiate node creates an instance of the Light Prefab, at the Prefab's Position and with the Prefab's Rotation. The graph saves the new instance of the GameObject to a Scene variable, Spotlight, so it can interact with the GameObject again later.

An image of the Graph window. An On Mouse Enter node's Trigger output port connects to the Invoke input port on an Instantiate GameObject node. The Instantiate GameObject's Original uses an inline value of the project's Light Prefab. A GameObject Literal node also uses the Light Prefab as an inline value. The GameObject Literal connects to a Transform Get Position node and a Transform Get Rotation node, which provide the Position and Rotation inputs for the Instantiate GameObject node. The Instantiate GameObject node's Exit port triggers the Assign input port on the Set Variable node, and assigns the new GameObject as the value of the Spotlight Scene variable.

The result is a spotlight that appears over the On Mouse Enter node's Target GameObject, when the user's mouse enters the Collider.

An image of the Game view, that displays a simple scene with a plane and a cube GameObject. The cube is lit by a spotlight from above.

Related nodes

[!includenodes-related] On Mouse Enter node: