How to change the CURSOR IMAGE on HOVER in Unity

Introduction

In this article we are going to see how to change the cursor image when the pointer hovers over a button in Unity. In addition, a download package is provided with the scripts, sprites and the scene that is shown in the following video:

How to change the CURSOR IMAGE on HOVER in Unity
๐Ÿ‘‰

PLEASE CONSIDER SUBSCRIBING TO MY CHANNEL

A SHORT BREAK WITH THE LATEST NEWS

CONSIDER SUBSCRIBING!


LET'S CONTINUE WITH THE ARTICLE

Download the Unity Package

Here you can download the Unity Package with the example on how to change the cursor image in Unity.

Change Cursor Sprite on mouse hover

PLEASE CONSIDER SUBSCRIBING TO THE CHANNEL


PRESS "DOWNLOAD NOW!" TO DOWNLOAD THE FILE

Fig. 1: Scene from the Unity package, the cursor is on the screen and it’s an arrow.
Fig. 2: Scene from the Unity package, the cursor is on the button and now change to a hand.

Default Cursor Settings in Unity

This is something that can be done within a Start function, but if our game or application will have a custom cursor, for example a custom arrow, it is convenient to define it within the project parameters, going to Edit > Project Settings, the window shown in Figure 3 is displayed, there we can assign the default cursor Sprite, as well as its Hotspot coordinates.

change default cursor image in unity and define the hotspot
Fig. 3: Default cursor settings in Unity.

Determining the Hotspot of our customized cursor

The hotspot of the cursor is the offset vector measured from the upper left corner of the Sprite and it indicates the point of the image where the tip of the cursor is considered to be. The script that comes in the package has fields defined to assign the Sprite of two cursors as well as the vectors of their respective Hotspots, as seen in the inspector in Figure 4.

To determine the Hotspots you have to enter the game mode and try different values until the cursor matches, another way would be to know exactly how many pixels horizontally and vertically is the point of the cursor.

script to change the cursor in unity
Fig. 4: Inspector of the Cursor Manager script included in the Unity package, Sprite assignment and Hotspot configuration.

How to change the cursor IMAGE in Unity

To change the image shown by the cursor just execute the instructions shown in figure 5, in lines 31 and 37, the SetCursor method inside the Cursor class, passing as parameter the sprite you want to show, the Vector2 with the position of the Hotspot and the cursor mode.

functions to change the cursor image in unity
Fig. 5: Functions to change the cursor image in Unity.

When to change the cursor image in Unity

In this particular case we are interested in constantly showing a default cursor until the pointer is positioned over a button, at that moment we want to show another different cursor to give feedback that the user can interact with that element. For this we need to be able to detect exactly when these events occur and for that I assign to each button an “Event Trigger” component and adding the “Pointer Enter” and “Pointer Exit” events.

To both events we assign the GameObject that has the Script with the functions that we want to execute (these functions must be defined as public) and then using the drop-down menu we choose the functions to execute in each event.

change cursor image when hovering over a button in unity
Fig. 6: Assignment of script functions to each event.

Secured By miniOrange