Version: Unity 6 (6000.0)
LanguageEnglish
  • C#

EventInterestAttribute

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

Optional attribute on overrides of CallbackEventHandler.HandleEventBubbleUp and CallbackEventHandler.HandleEventTrickleDown. Use this attribute to specify all the event types used by the method override. The event dispatcher can then safely skip events not needed for this method if they are identified internally as valid candidates for performance optimizations.

Only use this attribute for performance optimizations, not for filtering out specific event types. All event types specified in an EventInterestAttribute on a HandleEvent method override are guaranteed to be sent to that method. However, event types not specified in any EventInterestAttribute might still be sent to that method under various conditions:

  • A base class override uses it,
  • The event is part of a group that includes at least one event of interest, or
  • Event optimizations are not applied for any other reason.


If no EventInterestAttribute is specified, UI Toolkit assumes that the method doesn't have enough information on necessary event types, and sends all incoming events to that method conservatively.

It is recommended to use the EventInterestAttribute attribute because it allows UI Toolkit to optimize performance by skipping unnecessary event-related calculations for methods that don’t use the event.

Constructors

EventInterestAttribute Use this constructor when the affected method uses only specific event types that can easily be determined at compile time. Multiple EventInterestAttribute can be used on the same method to add more type interests.