Version: 2022.3
LanguageEnglish
  • C#

NavigationMoveEvent.GetPooled

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

Declaration

public static UIElements.NavigationMoveEvent GetPooled(Vector2 moveVector, EventModifiers modifiers);

Parameters

moveVector The move vector.
modifiers The modifier keys held down during the event.

Returns

NavigationMoveEvent An initialized navigation event.

Description

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().


Declaration

public static UIElements.NavigationMoveEvent GetPooled(UIElements.NavigationMoveEvent.Direction direction, EventModifiers modifiers);

Parameters

direction The logical direction of the navigation.
modifiers The modifier keys held down during the event.

Returns

NavigationMoveEvent An initialized navigation event.

Description

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().

This method doesn't set any move vector. For NavigationMoveEvents using move vector information, see GetPooled(UnityEngine.Vector2, UnityEngine.EventModifiers, UnityEngine.UIElements.NavigationDeviceType).