If you’re implementing custom controls, you can respond to UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Toolkit events in the following ways:
Your response to events depends on the situation. The following are the differences between callbacks and virtual method overrides:
A virtual method override applies to all instances of the class. For a class that overrides HandleEventBubbleUp
or HandleEventTrickleDown
, you can also register callbacks on its instances.
To override the HandleEventBubbleUp
or HandleEventTrickleDown
methods, or both, derive a new subclass of VisualElement
.
HandleEventBubbleUp
and HandleEventTrickleDown
execute on each instance of a visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary subclass when that instance receives an event.
The following example shows how to customize those virtual methods:
override void HandleEventBubbleUp(EventBase evt) { // Call the base function. base.HandleEventBubbleUp(evt); if (evt.eventTypeId == PointerDownEvent.TypeId()) { // ... } else if (evt.eventTypeId == MouseUpEvent.TypeId()) { // ... } // More event types }
For a given class instance, executing custom code in the following cases have the same results:
In either case, if you stop the propagation of the event, it prevents reactions to the event after you have executed the current target callbacks and method overrides.
The following are best practices for handing events with custom controls.
In general, to implement behaviors from your element, use a HandleEventBubbleUp
method override.
Given that the BubbleUp is the default propagation phase for callbacks, you can move any code from callbacks to a HandleEventBubbleUp
method without any concerns about changing the timing of code execution.
The benefits of implementing behaviors as method overrides include:
When handling an event inside a callback or a virtual method override, you can stop further event propagation by calling one of the StopPropagation methods on the event. For example, a parent panel might stop propagation during the trickle-down phase to prevent its children from receiving events.
You can’t prevent the execution of the EventBase.PreDispatch()
and EventBase.PostDispatch()
methods inside the event class itself.
The following methods affect event propagation:
StopImmediatePropagation()
: Stops the event propagation process immediately to prevent any subsequent callbacks from executing for the event.StopPropagation()
: Stops the event propagation process after the last callback on the current element. This ensures that all callbacks execute on the current element, while preventing any further elements from responding to the event.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:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.