Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


EventType

Types of UnityGUI input and processing events.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Enum
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule
public enum EventType

Remarks

Use this to tell which type of event has taken place in the GUI. Types of Events include mouse clicking, mouse dragging, button pressing, the mouse entering or exiting the window, and the scroll wheel as well as others mentioned below.
Events can be used to prevent other GUI elements from responding to that event. Refer to Event.Use.
Additional Resources: Event.type, Event, GUI Scripting Guide.

Examples

//Attach this script to a GameObject//This script is a basic overview of some of the Event Types available. It outputs messages depending on the current Event Type.using UnityEngine;public class Example : MonoBehaviour{ void OnGUI() { Event m_Event = Event.current; if (m_Event.type == EventType.MouseDown) { Debug.Log("Mouse Down."); } if (m_Event.type == EventType.MouseDrag) { Debug.Log("Mouse Dragged."); } if (m_Event.type == EventType.MouseUp) { Debug.Log("Mouse Up."); } }}
using UnityEngine;public class Example : MonoBehaviour{ void OnGUI() { Event m_Event = Event.current; if (m_Event.type == EventType.MouseDown) { if (m_Event.pointerType == PointerType.Pen) //Check if it's a pen event. Debug.Log("Pen Down."); else Debug.Log("Mouse Down.");         //If it's not a pen event, it's a mouse event. } }}

Fields

Value

Description

ContextClickUser has right-clicked (or control-clicked on the mac).
DragExitedEditor only: drag & drop operation exited.
DragPerformEditor only: drag & drop operation performed.
DragUpdatedEditor only: drag & drop operation updated.
ExecuteCommandExecute a special command (eg. copy & paste).
IgnoreEvent should be ignored.
KeyDownA keyboard key was pressed.
KeyUpA keyboard key was released.
LayoutA layout event.
MouseDownMouse button was pressed.
MouseDragMouse was dragged.
MouseEnterWindowMouse entered a window (Editor views only).
MouseLeaveWindowMouse left a window (Editor views only).
MouseMoveMouse was moved (Editor views only).
MouseUpMouse button was released.
RepaintA repaint event. One is sent every frame.
ScrollWheelThe scroll wheel was moved.
TouchDownDirect manipulation device (finger, pen) touched the screen.
TouchEnterDirect manipulation device (finger, pen) moving into the window (drag).
TouchLeaveDirect manipulation device (finger, pen) moved out of the window (drag).
TouchMoveDirect manipulation device (finger, pen) moved on the screen (drag).
TouchStationaryDirect manipulation device (finger, pen) stationary event (long touch down).
TouchUpDirect manipulation device (finger, pen) left the screen.
UsedAlready processed event.
ValidateCommandValidates a special command (e.g. copy & paste).