class in UnityEngine
/
Implemented in:UnityEngine.IMGUIModule
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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseA UnityGUI event.
Events correspond to user input (key presses, mouse actions), or are UnityGUI layout or rendering events.
For each event OnGUI is called in the scripts; so OnGUI is potentially
called multiple times per frame. Event.current corresponds to "current" event inside OnGUI call.
Additional resources: GUI Scripting Guide, EventType.
current | The current event that's being processed right now. |
alt | Is Alt/Option key held down? (Read Only) |
button | Which mouse button was pressed. |
capsLock | Is Caps Lock on? (Read Only) |
character | The character typed. |
clickCount | How many consecutive mouse clicks have we received. |
command | Is Command/Windows key held down? (Read Only) |
commandName | The name of an ExecuteCommand or ValidateCommand Event. |
control | Is Control key held down? (Read Only) |
delta | The relative movement of the mouse compared to last event. |
displayIndex | Index of display that the event belongs to. |
functionKey | Is the current keypress a function key? (Read Only) |
isKey | Is this event a keyboard event? (Read Only) |
isMouse | Is this event a mouse event? (Read Only) |
keyCode | The raw key code for keyboard events. |
modifiers | Which modifier keys are held down. |
mousePosition | The mouse position. |
numeric | Is the current keypress on the numeric keyboard? (Read Only) |
penStatus | Specifies the state of the pen. For example, whether the pen is in contact with the screen or tablet, whether the pen is inverted, and whether buttons are pressed. |
pointerType | The type of pointer that created this event (for example, mouse, touch screen, pen). |
pressure | How hard pen pressure is applied, normalized between 0 (no pressure) and 1 (maximum pressure). |
shift | Is Shift held down? (Read Only) |
tilt | Specifies the angle of the pen relative to the X and Y axes, expressed in radians. |
twist | Specifies the rotation of the pen around its axis, expressed in radians. The default value is 0. |
type | The type of event. |
GetTypeForControl | Get a filtered event type for a given control ID. |
Use | Use this event. |
GetEventCount | Returns the current number of events that are stored in the event queue. |
KeyboardEvent | Create a keyboard event. |
PopEvent | Get the next queued [Event] from the event system. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.