class in UnityEngine.UIElements
/
Inherits from:UIElements.MouseEventBase_1
/
Implemented in:UnityEngine.UIElementsModule
This event is sent when a mouse button is released.
The mouse up event is sent to a visual element when a mouse button is released inside the element. A MouseUpEvent uses the default mouse event propagation path: it trickles down, bubbles up and can be cancelled. Disabled elements won't receive this event by default.
| MouseUpEvent | Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. |
| Init | Resets the event members to their initial values. |
| GetPooled | Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. |
| bubbles | Returns whether this event type bubbles up in the event propagation path. |
| currentTarget | The current target of the event. This is the VisualElement, in the propagation path, for which event handlers are currently being executed. |
| dispatch | Indicates whether the event is being dispatched to a visual element. An event cannot be redispatched while it being dispatched. If you need to recursively dispatch an event, it is recommended that you use a copy of the event. |
| eventTypeId | Retrieves the type ID for this event instance. |
| imguiEvent | The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI. |
| isDefaultPrevented | Returns true if the default actions should not be executed for this event. |
| isImmediatePropagationStopped | Indicates whether StopImmediatePropagation() was called for this event. |
| isPropagationStopped | Whether StopPropagation() was called for this event. |
| originalMousePosition | The original mouse position of the IMGUI event, before it is transformed to the current target local coordinates. |
| pooled | Whether the event is allocated from a pool of events. |
| propagationPhase | The current propagation phase for this event. |
| target | The target visual element that received this event. Unlike currentTarget, this target does not change when the event is sent to other elements along the propagation path. |
| timestamp | The time when the event was created, in milliseconds. |
| tricklesDown | Returns whether this event is sent down the event propagation path during the TrickleDown phase. |
| eventTypeId | Retrieves the type ID for this event instance. |
| actionKey | Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. |
| altKey | Returns true if the Alt key is pressed. |
| button | Integer that indicates which mouse button is pressed: 0 is the left button, 1 is the right button, 2 is the middle button. |
| clickCount | The number of times the button is pressed. |
| commandKey | Returns true if the Windows/Cmd key is pressed. |
| ctrlKey | Returns true if the Ctrl 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 | Flags that hold pressed modifier keys (Alt, Ctrl, Shift, Windows/Cmd). |
| mouseDelta | The difference of the mouse position between the previous mouse event and the current mouse event. |
| mousePosition | The mouse position in the screen coordinate system. |
| pressedButtons | A bitmask that describes the currently pressed buttons. |
| shiftKey | Returns true if the Shift key is pressed. |
| Dispose | Implementation of IDisposable. |
| PreventDefault | Indicates whether the default actions are prevented from being executed for this event. |
| StopImmediatePropagation | Immediately stops the propagation of the event. The event isn't sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target. |
| StopPropagation | Stops propagating this event. The event is not sent to other elements along the propagation path. This method does not prevent other event handlers from executing on the current target. |
| Dispose | Implementation of IDispose. |
| PostDispatch | Allows subclasses to perform custom logic after the event has been dispatched. |
| PreDispatch | Allows subclasses to perform custom logic before the event is dispatched. |
| RegisterEventType | Registers an event class to the event type system. |
| GetPooled | Gets an event from the event pool. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. |
| TypeId | Retrieves the type ID for this event instance. |