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.