Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine
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
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
A 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.
See Also: 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)|
|shift||Is Shift held down? (Read Only)|
|type||The type of event.|
|GetTypeForControl||Get a filtered event type for a given control ID.|
|Use||Use this event.|