class in UnityEngine.UIElements
/
Inherits from:UIElements.NavigationEventBase_1
/
Implemented in:UnityEngine.UIElementsModule
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.
CloseFor 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.
CloseEvent typically sent when the user presses the D-pad, moves a joystick or presses the arrow keys.
NavigationMoveEvent | Constructor. |
Init | Initialize the event members. |
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(). |
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 | Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. |
altKey | Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. |
commandKey | Gets a boolean value that indicates whether the Windows/Cmd key is pressed. True means the Windows/Cmd key is pressed. False means it isn't. |
ctrlKey | Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. |
modifiers | Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. |
shiftKey | Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. |
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. |
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:
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.