Legacy Documentation: Version 4.6
Language: English
Log Files
Messaging System

EventSystem

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

The EventSystem is a way of sending events to objects in the application based on input, be it keyboard, mouse, touch, or custom input. The EventSystem consists of a few components that work together to send events.

Overview

When you add an EventSystem component to a GameObject you will notice that it does not have much functionality exposed, this is because the EventSystem itself is designed as a manager and facilitator of communication between EventSystem modules.

The primary roles of the EventSystem are as follows:

  • Manage which GameObject is considered selected
  • Manage which InputModule is in use
  • Manage Raycasting (if required)
  • Updating all InputModules as required

Input Modules

An input module is where the main logic of how you want the EventSystem to behave lives, they are used for

  • Handling Input
  • Managing event state
  • Sending events to scene objects.

Only one InputModule can be active in the EventSystem at a time, and they must be components on the same GameObject as the EventSystem component.

If you wish to write a custom input module it is recommended that you send events supported by existing UI components in Unity, but you are also able to extend and write your own events as detailed in the Messaging System documentation.

Raycasters

Raycasters are used for sending figuring out what the pointer is over, it is common for InputModules to use the Raycasters configured in the scene to calculate what the pointing device is over.

There are 3 provided Raycasters that exist by default:

  • GraphicRaycaster - Used for UI elements
  • 2DPhysicsRaycaster - Used for 2D physics elements
  • 3DPhysicsRaycaster - Used for 3D physics elements

If you have a 2d / 3d Raycaster configured in your scene it is easily possible to have non UI elements receive messages from the InputModule. Simply attach a script that implements one of the event interfaces.

Log Files
Messaging System