KeyboardEventBase<T0>
класс в UnityEngine.UIElements
Наследуется от:UIElements.EventBase_1
Выполнено в:UnityEngine.UIElementsModule
Интерфейсы приспособлений:IKeyboardEvent
Описание
Это базовый класс для событий клавиатуры.
Типичный цикл событий клавиатуры выглядит следующим образом: — При нажатии клавиши, KeyDownEvent — Если ключ удерживается в течение периода времени, определяемого ключом, OS, другое KeyDownEvent Пока клавишная комбинация удерживается нажатой, событие посылается повторно с частотой, определяемой клавишной комбинацией, а затем OS. — при отключении ключа KeyUpEvent отправляется.
По умолчанию события клавиатуры просачиваются вниз и вверх. отключенные элементы не получат эти события.
См. Клавиатурные события для получения дополнительной информации и примеров см. страницу руководства.
Дополнительные ресурсы: KeyDownEvent, KeyUpEvent
Свойства
| Свойство | Описание |
|---|---|
| actionKey | Получает логическое значение, указывающее, нажата ли клавиша действия для конкретной платформы. |
| altKey | Получает логическое значение, указывающее, нажата ли клавиша Alt. |
| character | Получает введенный символ. |
| commandKey | Получает логическое значение, указывающее, нажата ли клавиша Windows/Cmd. |
| ctrlKey | Получает логическое значение, указывающее, нажата ли клавиша Ctrl. |
| keyCode | Ключевой код. |
| modifiers | Получает флаги, указывающие, нажаты ли клавиши модификаторов (Alt, Ctrl, Shift, Windows/Cmd). |
| shiftKey | Получает логическое значение, указывающее, нажата ли клавиша Shift. |
Защищенные методы
| Метод | Описание |
|---|---|
| Init | Сброс членов события до их исходных значений. |
Статические методы
| Метод | Описание |
|---|---|
| GetPooled | Получает событие клавиатуры из пула событий и инициализирует его с указанными значениями. Используйте эту функцию вместо создания новых событий. События, полученные с помощью этого метода, должны быть выпущены обратно в пул. Вы можете использовать Dispose() для их выпуска. |
Унаследованные члены 4
Свойства
| Свойство | Описание |
|---|---|
| bubbles | Возвращает информацию о том, появляется ли этот тип события в пути распространения событий во время фазы BubbleUp. |
| currentTarget | Текущий объект события. Это VisualElement в пути распространения, для которого в настоящее время выполняются обработчики событий. |
| dispatch | Показывает, отправляется ли событие в визуальный элемент. Событие не может быть переадресовано в процессе отправки. Если необходимо рекурсивно отправить событие, рекомендуется использовать копию события. |
| ignoreDisabledElements | Если это свойство установлено на true, обратные вызова для этого события не вызываются при отключении текущей цели, если только эти обратные вызова не зарегистрированы с помощью параметра CallbackOptions.IncludeDisabled. |
| imguiEvent | IMGUIEvent в источнике этого события. Источник может быть нулевым, поскольку не все события генерируются IMGUI. |
| isImmediatePropagationStopped | Указывает, был ли вызван StopImmediatePropagation для этого события. |
| isPropagationStopped | Возвращает true, если StopPropagation или StopImmediatePropagation были вызваны для этого события. |
| originalMousePosition | Первоначальное положение мыши в событии IMGUI до его преобразования в текущие целевые локальные координаты. |
| pooled | Выделяется ли событие из пула событий. |
| propagationPhase | Текущая фаза распространения этого события. |
| target | Конечный визуальный элемент, получивший это событие. В отличие от currentTarget, этот конечный элемент не изменяется, когда событие отправляется другим элементам по пути распространения. |
| timestamp | Время отправки события в миллисекундах. |
| tricklesDown | Возвращает информацию о том, отправляется ли это событие по пути распространения событий в фазе TrickleDown. |
| eventTypeId | См. EventBase.eventTypeId. |
Открытые методы
| Метод | Описание |
|---|---|
| StopImmediatePropagation | Остановка распространения события на другие конечные объекты и предотвращение получения события другими подписчиками события на этом конечном объекте. |
| StopPropagation | Прекращает распространение события на другие конечные объекты. Все подписчики на событие на этом конечном объекте по-прежнему получают событие. |
| Dispose | Осуществление IDispose. |
Защищенные методы
| Метод | Описание |
|---|---|
| PostDispatch | Позволяет подклассам выполнять настраиваемую логику после отправки события. |
| PreDispatch | Позволяет подклассам выполнять настраиваемую логику до отправки события. |
Статические методы
| Метод | Описание |
|---|---|
| RegisterEventType | Регистрирует класс события в системе типов событий. |
| GetPooled | Получает событие из пула событий. Используйте эту функцию вместо создания новых событий. События, полученные с помощью этого метода, должны быть выпущены обратно в пул. Вы можете использовать Dispose() для их выпуска. |
| SetCreateFunction | Позволяет предоставить функцию для создания экземпляра события без зависимости от Activator.CreateInstance. |
| TypeId | Получает тип ID для этого экземпляра события. |