MouseDownEvent

class in UnityEngine.UIElements

Description

Mouse down event.

Constructors

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Inherited Members

Properties

bubbles	Whether this event type bubbles up in the event propagation path.
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	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	Return true if the default actions should not be executed for this event.
isImmediatePropagationStopped	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.
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.
tricklesDown	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 Command on macOS and Control otherwise.
altKey	Returns 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	Returns true if the Windows/Command key is pressed.
ctrlKey	Returns 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	Flags holding the pressed modifier keys (Alt, Control, Shift, Windows/Command).
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.
shiftKey	Returns true if the Shift key is pressed.

Public Methods

Dispose	Implementation of IDisposable.
PreventDefault	Whether the default actions are prevented from being executed for this event.
StopImmediatePropagation	Immediately stops the propagation of the event. The event is not 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.

Protected Methods

Init	Resets all event members to their initial values.
Init	Resets all event members to their initial values.
Init	Resets the event members to their initial values.

Static Methods

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 from this method should be released back to the pool using Dispose().
TypeId	Gets the type id for the event class.
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 from this method should be released back to the pool using Dispose().

Did you find this page useful? Please give it a rating:

Report a problem on this page

Scripting API