Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine.Experimental.UIElements
/
Inherits from:Experimental.UIElements.EventBase_1
Implements interfaces:IMouseCaptureEvent
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.
CloseEvent sent when the handler capturing the mouse changes.
Init | Reset the event members to their initial value. |
GetPooled | Retrieves an event from the event pool. Use this method to retrieve a mouse event and initialize the event, instead of creating a new mouse event. |
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. |
flags | Flags for the event. |
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. |
originalMousePosition | The original mouse position of the IMGUI event, before it is transformed to the local element coordinates. |
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. |
Dispose | Implementation of IDisposable. |
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. |
Dispose | Implementation of IDispose. |
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:
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:
Thanks for helping to make the Unity documentation better!