class in UnityEngine.UIElements
/
Inherits from:UIElements.NavigationEventBase_1
/
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 failedFor 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 Your name Your email Suggestion* DescriptionEvent typically sent when the user presses the D-pad, moves a joystick or presses the arrow keys.
Properties Property Description direction The direction of the navigation. move The move vector, if applicable. Protected Methods Method Description Init Initialize the event members. Static Methods Method Description 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(). Inherited Members Properties Property Description 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. 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. eventTypeId See EventBase.eventTypeId. 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. Public Methods Method Description 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. Dispose Implementation of IDispose. Protected Methods Method Description 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 Method Description 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().RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4