版本: Unity 6 (6000.0)
语言英语
  • C#

KeyboardEventBase<T0>

UnityEngine.UIElements 中的类

/

继承自:UIElements.EventBase_1

/

实现于:UnityEngine.UIElementsModule


实现接口:IKeyboardEvent

建议更改

成功!

感谢您帮助我们改进 Unity 文档的质量。虽然我们无法接受所有提交,但我们会阅读用户提出的每项建议更改,并在适用情况下进行更新。

关闭

提交失败

由于某种原因,您的建议更改无法提交。请<a>稍后再试</a>。感谢您花时间帮助我们改进 Unity 文档的质量。

关闭

取消

描述

这是键盘事件的基类。

典型的键盘事件循环如下:- 当按下键时,将发送一个 KeyDownEvent。- 如果该键被按下并保持一段时间,该时间由操作系统决定,则会发送另一个具有相同数据的 KeyDownEvent。在按住键的过程中,事件会以操作系统决定的频率重复发送。- 当释放键时,将发送一个 KeyUpEvent

默认情况下,键盘事件会向下传递并向上冒泡。禁用的元素不会接收到这些事件。

属性

actionKey获取一个布尔值,指示平台特定的动作键是否被按下。True 表示动作键被按下。False 表示没有按下。
altKey获取一个布尔值,指示 Alt 键是否被按下。True 表示 Alt 键被按下。False 表示没有按下。
character获取输入的字符。
commandKey获取一个布尔值,指示 Windows/Cmd 键是否被按下。True 表示 Windows/Cmd 键被按下。False 表示没有按下。
ctrlKey获取一个布尔值,指示 Ctrl 键是否被按下。True 表示 Ctrl 键被按下。False 表示没有按下。
keyCode键码。
modifiers获取指示修饰键(Alt、Ctrl、Shift、Windows/Cmd)是否被按下的标志。
shiftKey获取一个布尔值,指示 Shift 键是否被按下。True 表示 Shift 键被按下。False 表示没有按下。

受保护的方法

Init将事件成员重置为其初始值。

静态方法

GetPooled从事件池中获取一个键盘事件,并使用给定值初始化它。使用此函数代替创建新的事件。使用此方法获得的事件需要释放回池。您可以使用 Dispose() 来释放它们。

继承的成员

属性

bubbles返回此事件类型在事件传播路径中是否向上冒泡。
currentTarget事件的当前目标。这是事件处理程序当前正在执行的传播路径中的 VisualElement。
dispatch指示事件是否正在分派到可视元素。在事件分派过程中,事件不能被重新分派。如果您需要递归地分派事件,建议您使用事件的副本。
imguiEvent此事件来源的 IMGUIEvent。源可以为 null,因为并非所有事件都由 IMGUI 生成。
isImmediatePropagationStopped指示是否为此事件调用了 StopImmediatePropagation()。
isPropagationStopped是否为此事件调用了 StopPropagation()。
originalMousePositionIMGUI 事件的原始鼠标位置,在转换为当前目标本地坐标之前。
pooled事件是否从事件池中分配。
propagationPhase此事件的当前传播阶段。
target接收此事件的目标可视元素。与 currentTarget 不同,当事件沿传播路径发送到其他元素时,此目标不会改变。
timestamp事件创建时的毫秒数。
tricklesDown返回此事件在 TrickleDown 阶段是否沿事件传播路径向下发送。
eventTypeId检索此事件实例的类型 ID。

公共方法

StopImmediatePropagation立即停止事件的传播。事件不会发送到传播路径中的其他元素。此方法阻止其他事件处理程序在当前目标上执行。
StopPropagation停止传播此事件。事件不会发送到传播路径中的其他元素。此方法不会阻止其他事件处理程序在当前目标上执行。如果在 TrickleDown 传播阶段调用此方法,它将阻止默认操作被处理,例如元素由于 PointerDownEvent 导致获得焦点。
DisposeIDispose 的实现。

受保护的方法

PostDispatch允许子类在事件分派后执行自定义逻辑。
PreDispatch允许子类在事件分派之前执行自定义逻辑。

静态方法

RegisterEventType将事件类注册到事件类型系统。
GetPooled从事件池中获取事件。使用此函数代替创建新的事件。使用此方法获得的事件需要释放回池。您可以使用 Dispose() 来释放它们。
TypeId检索此事件实例的类型 ID。