Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

EventBase

class in UnityEngine.UIElements

/

Implemented in:UnityEngine.UIElementsModule

Suggest a change

Success!

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

Submission failed

For 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.

Close

Cancel

Description

The base class for all UIElements events. The class implements IDisposable to ensure proper release of the event from the pool and of any unmanaged resources, when necessary.

Properties

bubbles Returns whether this event type bubbles up in the event propagation path during the BubbleUp phase.
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.
isImmediatePropagationStopped Indicates whether StopImmediatePropagation was called for this event.
isPropagationStopped Returns true if StopPropagation or StopImmediatePropagation 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.

Public Methods

Dispose Implementation of IDisposable.
StopImmediatePropagation Stops the propagation of the event to other targets, and prevents other subscribers to the event on this target to receive the event.
StopPropagation Stops the propagation of the event to other targets. All subscribers to the event on this target still receive the event.

Protected Methods

Init Resets all event members to their initial values.
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.

Static Methods

RegisterEventType Registers an event class to the event type system.