class in UnityEngine.Experimental.UIElements
/
Inherits from:Experimental.UIElements.EventBase_1
Implements interfaces:IMouseEvent
The base class for mouse events.
| altKey | Return true if the Alt key is pressed. |
| button | Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center. |
| clickCount | Number of clicks. |
| commandKey | Return true if the Windows/Command key is pressed. |
| ctrlKey | Return true if the Control key is pressed. |
| currentTarget | The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. |
| localMousePosition | The mouse position in the current target coordinate system. |
| modifiers | Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). |
| mouseDelta | Mouse position difference between the last mouse event and this one. |
| mousePosition | The mouse position in the screen coordinate system. |
| shiftKey | Return true if the Shift key is pressed. |
| Init | Reset the event members to their initial value. |
| GetPooled | Get an event from the event pool and initialize it with the given values. Use this function instead of newing events. Events obtained from this function should be released back to the pool using ReleaseEvent(). |
| bubbles | Returns whether this event type bubbles up in the event propagation path. |
| capturable | Return whether this event is sent down the event propagation path during the capture phase. |
| currentTarget | The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. |
| dispatch | Return whether the event is currently being dispatched to visual element. An event can not be redispatched while being dispatched. If you need to recursively redispatch an event, you should use a copy. |
| imguiEvent | The IMGUIEvent at the source of this event. This can be null as not all events are generated by IMGUI. |
| isDefaultPrevented | Return true if the default actions should not be executed for this event. |
| isImmediatePropagationStopped | Return true if StopImmediatePropagation() has been called for this event. |
| isPropagationStopped | Return true if StopPropagation() has been called for this event. |
| propagationPhase | The current propagation phase. |
| target | The target for this event. The is the visual element that received the event. Unlike currentTarget, target does not change when the event is sent to elements along the propagation path. |
| timestamp | The time at which the event was created. |
| GetEventTypeId | Get the type id for this event instance. |
| PreventDefault | Call this function to prevent the execution of the default actions for this event. |
| StopImmediatePropagation | Immediately stop the propagation of this event. The event will not be sent to any further event handlers on the current target or on any other element in the propagation path. |
| StopPropagation | Stop the propagation of this event. The event will not be sent to any further element in the propagation path. Further event handlers on the current target will be executed. |
| GetEventTypeId | Get the type id for this event instance. |
| RegisterEventType | Register an event class to the event type system. |
| GetPooled | Get an event from the event pool. Use this function instead of newing events. Events obtained from this function should be released back to the pool using ReleaseEvent(). |
| ReleasePooled | Release an event obtained from GetPooled(). |
| TypeId | Get the type id for this event instance. |
Did you find this page useful? Please give it a rating: