In this tutorial, we will learn how to hide and control the mouse cursor in Unity. Hiding and controlling the mouse cursor during the development of games or simulations is an important technique that helps enhance user experience. This is particularly essential when managing interactions in FPS (first-person shooter) games or with specific UI elements.<\/p>\n
Hiding the mouse cursor is a straightforward process in Unity. This can increase the user’s immersion, allowing them to focus more on specific elements on the screen. To hide the cursor and implement certain functionalities, some basic script modifications and UI settings are required.<\/p>\n
Through this tutorial, we aim to achieve the following goals:<\/p>\n
First, we need to set up a Unity project. This will proceed under the assumption that Unity is already installed.<\/p>\n
Open Unity Hub and click the ‘New Project’ button. Here are the basic settings:<\/p>\n
MouseCursorHiding<\/code><\/li>\n- Template Selection:
3D<\/code><\/li>\n- Location: Set your desired location.<\/li>\n<\/ul>\n
Then click the ‘Create’ button to generate the project.<\/p>\n
2.2. Setting Up the Initial Scene<\/h3>\n
To set up the scene, we will add a simple 3D object. For example, add a cube or a plane.<\/p>\n
\n- In the Hierarchy window, select
Right Click<\/code> > 3D Object<\/code> > Cube<\/code> to add a cube.<\/li>\n- Adjust the size of the cube to a suitable dimension and position it at the center.<\/li>\n<\/ul>\n
3. Writing the Basic Script<\/h2>\n
We need to write a script to hide the mouse cursor. We will use C# for this.<\/p>\n
3.1. Creating the Script<\/h3>\n
The next step is to create a new C# script.<\/p>\n
\n- In the Project window, select
Right Click<\/code> > Create<\/code> > C# Script<\/code> to create a new script.<\/li>\n- Name the script
CursorController<\/code>.<\/li>\n- Double-click on the newly created script to open it in a code editor.<\/li>\n<\/ul>\n
3.2. Writing the Code<\/h3>\n
The code to write is as follows:<\/p>\n
using UnityEngine;\n\npublic class CursorController : MonoBehaviour\n{\n void Start()\n {\n \/\/ Hide the cursor.\n Cursor.visible = false;\n \/\/ Set the cursor lock state to center.\n Cursor.lockState = CursorLockMode.Locked;\n }\n\n void Update()\n {\n \/\/ Change the cursor state when the mouse button is clicked.\n if (Input.GetMouseButtonDown(0))\n {\n ToggleCursor();\n }\n }\n\n void ToggleCursor()\n {\n \/\/ Show or hide based on the current cursor state.\n if (Cursor.visible)\n {\n Cursor.visible = false;\n Cursor.lockState = CursorLockMode.Locked;\n }\n else\n {\n Cursor.visible = true;\n Cursor.lockState = CursorLockMode.None;\n }\n }\n}\n<\/code><\/pre>\nThe above script hides the cursor and locks it in place when the game starts. When the user clicks the mouse button, it toggles the visibility of the cursor.<\/p>\n
4. Applying the Script<\/h2>\n
You need to apply the written script to the scene.<\/p>\n
\n- Select
Cube<\/code> from the Hierarchy.<\/li>\n- In the Inspector window, click the
Add Component<\/code> button and search for CursorController<\/code> to add it.<\/li>\n<\/ul>\nNow, when you run the scene, you will see that the mouse cursor is hidden. Clicking the mouse button will make the cursor reappear.<\/p>\n
5. Adding Advanced Features<\/h2>\n
After implementing the basic cursor hiding functionality, you can develop additional advanced features.<\/p>\n
5.1. Integration with UI Elements<\/h3>\n
When interacting with the in-game UI, there may be a need to show the cursor. You can make it so the cursor appears when clicking on the UI.<\/p>\n
To do this, add UI click detection to the ToggleCursor<\/code> method:<\/p>\nusing UnityEngine;\nusing UnityEngine.EventSystems;\n\npublic class CursorController : MonoBehaviour, IPointerEnterHandler, IPointerExitHandler\n{\n void Start()\n {\n Cursor.visible = false;\n Cursor.lockState = CursorLockMode.Locked;\n }\n\n void Update()\n {\n if (Input.GetMouseButtonDown(0))\n {\n ToggleCursor();\n }\n }\n\n void ToggleCursor()\n {\n if (Cursor.visible)\n {\n Cursor.visible = false;\n Cursor.lockState = CursorLockMode.Locked;\n }\n else\n {\n Cursor.visible = true;\n Cursor.lockState = CursorLockMode.None;\n }\n }\n\n public void OnPointerEnter(PointerEventData eventData)\n {\n Cursor.visible = true;\n }\n\n public void OnPointerExit(PointerEventData eventData)\n {\n Cursor.visible = false;\n Cursor.lockState = CursorLockMode.Locked;\n }\n}\n<\/code><\/pre>\nThis will enable the cursor to be visible when hovering over UI elements and hide again when it leaves the UI.<\/p>\n
6. Conclusion and Final Testing<\/h2>\n
Once all the above steps are completed, it\u2019s time to build the project and conduct testing. Make sure all functions work correctly and make adjustments as needed.<\/p>\n
6.1. Build Settings<\/h3>\n