Version: 2018.2
语言: 中文

StandaloneInputModule

class in UnityEngine.EventSystems

/

继承自：EventSystems.PointerInputModule

切换到手册

描述

专为鼠标/键盘/控制器输入设计的 BaseInputModule。

适用于鼠标、键盘或控制器的输入模块。

变量

cancelButton“cancel”按钮的输入管理器名称。
forceModuleActive强制激活此模块。
horizontalAxis水平轴按钮的输入管理器名称。
inputActionsPerSecond每秒允许的键盘/控制器输入次数。
repeatDelay每秒输入操作重复率生效前的延迟秒数。
submitButton每秒处理的输入事件数上限。
verticalAxis垂直轴的输入管理器名称。

公共函数

ActivateModule请参阅 BaseInputModule。
DeactivateModule请参阅 BaseInputModule。
IsModuleSupported请参阅 BaseInputModule。
Process请参阅 BaseInputModule。
ShouldActivateModule请参阅 BaseInputModule。
UpdateModule请参阅 BaseInputModule。

受保护的函数

ProcessMouseEvent通过所有不同的鼠标事件迭代。
ProcessMousePress计算并处理任何鼠标按钮状态更改。
ProcessTouchPress每当处理触摸事件时，Unity 都会调用此方法。使用自定义实现重载此方法，以自行处理触摸事件。
SendMoveEventToSelectedObject计算移动事件并将其发送到当前选定对象。
SendSubmitEventToSelectedObject计算提交事件并将其发送到当前选定对象。
SendUpdateEventToSelectedObject将更新事件发送到当前选定对象。

继承的成员

静态变量

kFakeTouchesId触控 ID，用于在非触摸设备上模拟触摸的情况。
kMouseLeftId缓存的向左鼠标指针事件的 ID。
kMouseMiddleId缓存的居中鼠标指针事件的 ID。
kMouseRightId缓存的向右鼠标指针事件的 ID。

变量

input输入模块使用的当前 BaseInput。
inputOverride用于覆盖输入模块的默认 BaseInput。
enabled启用的 Behaviour 可更新，禁用的 Behaviour 不可更新。
isActiveAndEnabled已调用启用的 Behaviour。
gameObject此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag此游戏对象的标签。
transform附加到此 GameObject 的 Transform。
runInEditMode允许 MonoBehaviour 的特定实例在编辑模式下运行（仅可在 Editor 中使用）。
useGUILayout禁用该属性可跳过 GUI 布局阶段。
hideFlags该对象应该隐藏、随场景一起保存还是由用户修改？
name对象的名称。

公共函数

IsPointerOverGameObject具有给定 ID 的指针是否位于 EventSystem 对象上？
BroadcastMessage调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTag此游戏对象是否使用 tag 进行了标记？
GetComponent如果游戏对象附加了类型为 type 的组件，则将其返回，否则返回 null。
GetComponentInChildren使用深度首次搜索返回 GameObject 或其任何子项中类型为 type 的组件。
GetComponentInParent返回 GameObject 或其任何父项中类型为 type 的组件。
GetComponents返回 GameObject 中类型为 type 的所有组件。
GetComponentsInChildren返回 GameObject 或其任何子项中类型为 type 的所有组件。
GetComponentsInParent返回 GameObject 或其任何父项中类型为 type 的所有组件。
SendMessage调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
CancelInvoke取消该 MonoBehaviour 上的所有 Invoke 调用。
Invoke在 time 秒后调用 methodName 方法。
InvokeRepeating在 time 秒后调用 methodName 方法，然后每 repeatRate 秒调用一次。
IsInvoking是否有任何待处理的 methodName 调用？
StartCoroutine启动一个协同程序。
StopAllCoroutines停止在该行为上运行的所有协同程序。
StopCoroutine停止在该行为上运行的第一个名为 methodName 的协同程序或存储在 routine 中的协同程序。
GetInstanceID返回对象的实例 ID。
ToString返回 GameObject 的名称。
IsActive如果 GameObject 和 Component 处于激活状态，则返回 true。
IsDestroyed如果行为的原生表示已被销毁，则返回 true。

受保护的函数

GetAxisEventData提供了一些输入数据，生成事件系统可以使用的 AxisEventData。
GetBaseEventData生成 EventSystem 可以使用的 BaseEventData。
HandlePointerExitAndEnter当发现新的输入目标时处理正在发送的进入和退出事件。
OnDisable请参阅 MonoBehaviour.OnDisable。
OnEnable请参阅 MonoBehaviour.OnEnable。
ClearSelection清除所有指针并取消选择 EventSystem 中的任何已选择对象。
CopyFromTo将一个 PointerEventData 复制到另一个。
DeselectIfSelectionChanged取消选择当前已选择的游戏对象（如果指针当前指向的是其他游戏对象）。
GetLastPointerEventData返回给定触控 ID/鼠标 ID 的最后一个 PointerEventData。
GetMousePointerEventData返回当前 MouseState。
GetPointerData搜索当前处于激活状态的指针的缓存；如果找到，则返回 true。
GetTouchPointerEventData给定一个触摸，在按下或松开时填充 PointerEventData 并返回。
ProcessDrag使用给定指针事件处理当前帧的拖动。
ProcessMove使用给定指针事件处理当前帧的移动。
RemovePointerData从缓存中删除 PointerEventData。
StateForMouseButton给定一个鼠标按钮，返回帧的当前状态。
Awake请参阅 MonoBehaviour.Awake。
OnBeforeTransformParentChanged请参阅 MonoBehaviour.OnBeforeTransformParentChanged。
OnCanvasGroupChanged请参阅 MonoBehaviour.OnCanvasGroupChanged。
OnCanvasHierarchyChanged在父画布的状态发生更改时调用。
OnDestroy请参阅 MonoBehaviour.OnDestroy。
OnDidApplyAnimationProperties请参阅 LayoutGroup.OnDidApplyAnimationProperties。
OnDisable请参阅 MonoBehaviour.OnDisable。
OnEnable请参阅 MonoBehaviour.OnEnable。
OnRectTransformDimensionsChange如果关联的 RectTransform 的尺寸发生更改，则系统会调用此回调。
OnTransformParentChanged请参阅 MonoBehaviour.OnRectTransformParentChanged。
OnValidate请参阅 MonoBehaviour.OnValidate。
Reset请参阅 MonoBehaviour.Reset。
Start请参阅 MonoBehaviour.Start。

静态函数

DetermineMoveDirection提供了输入移动，确定最佳 MoveDirection。
FindCommonRoot提供了 2 个 GameObject，返回一个公共根 GameObject（或 null）。
FindFirstRaycast返回第一个有效 RaycastResult。
print将消息记录到 Unity 控制台（与 Debug.Log 相同）。
Destroy删除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad在加载新的 Scene 时，请勿销毁 Object。
FindObjectOfType返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType返回所有类型为 type 的已加载的激活对象的列表。
Instantiate克隆 original 对象并返回克隆对象。

运算符

bool该对象是否存在？
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用，判断它们是否引用同一个对象。

消息

AwakeAwake 在加载脚本实例时调用。
FixedUpdate如果启用了 MonoBehaviour，则每个固定帧率帧调用该函数。
LateUpdate如果启用了 Behaviour，则每帧调用 LateUpdate。
OnAnimatorIK用于设置动画 IK（反向运动学）的回调。
OnAnimatorMove用于处理动画移动以修改根运动的回调。
OnApplicationFocus当玩家获得或失去焦点时，发送给所有 GameObject。
OnApplicationPause当应用程序暂停时，发送给所有 GameObject。
OnApplicationQuit在应用程序退出前，发送给所有游戏对象。
OnAudioFilterRead如果实现了 OnAudioFilterRead，Unity 将在音频 DSP 链中插入一个自定义滤波器。
OnBecameInvisibleOnBecameInvisible 在渲染器对任何摄像机都不可见时调用。
OnBecameVisibleOnBecameVisible 在渲染器变为对任意摄像机可见时调用。
OnCollisionEnter当该碰撞体/刚体已开始接触另一个刚体/碰撞体时，调用 OnCollisionEnter。
OnCollisionEnter2D当传入碰撞体与该对象的碰撞体接触时发送（仅限 2D 物理）。
OnCollisionExit当该碰撞体/刚体已停止接触另一个刚体/碰撞体时，调用 OnCollisionExit。
OnCollisionExit2D当另一个对象上的碰撞体停止接触该对象的碰撞体时发送（仅限 2D 物理）。
OnCollisionStay对应正在接触刚体/碰撞体的每一个碰撞体/刚体，每帧调用一次 :ref::OnCollisionStay。
OnCollisionStay2D在另一个对象上的碰撞体正在接触该对象的碰撞体时发送每个帧（仅限 2D 物理）。
OnConnectedToServer成功连接到服务器后在客户端上调用。
OnControllerColliderHit当该控制器在执行 Move 时撞到碰撞体时调用 OnControllerColliderHit。
OnDestroy销毁附加的行为将导致游戏或场景收到 OnDestroy。
OnDisable该函数在行为被禁用时调用。
OnDisconnectedFromServer当连接丢失或与服务器断开连接时，在客户端上调用。
OnDrawGizmos如果您想绘制能够选择并且始终绘制的辅助图标，则可以实现 OnDrawGizmos。
OnDrawGizmosSelected如果选择了对象，则实现 OnDrawGizmosSelected 来绘制辅助图标。
OnEnable该函数在对象变为启用和激活状态时调用。
OnFailedToConnect出于某种原因连接尝试失败时，在客户端上调用。
OnFailedToConnectToMasterServer在连接到 MasterServer 时发生问题的情况下，在客户端或服务器上调用。
OnGUI系统调用 OnGUI 来渲染和处理 GUI 事件。
OnJointBreak在附加到相同游戏对象的关节断开时调用。
OnJointBreak2D在附加到相同游戏对象的 Joint2D 断开时调用。
OnMasterServerEvent在从 MasterServer 报告事件时，在客户端或服务器上调用。
OnMouseDown当用户在 GUIElement 或 Collider 上按下鼠标按钮时，将调用 OnMouseDown。
OnMouseDrag当用户单击 GUIElement 或 Collider 并仍然按住鼠标时，将调用 OnMouseDrag。
OnMouseEnter当鼠标进入 GUIElement 或 Collider 时调用。
OnMouseExit当鼠标不再处于 GUIElement 或 Collider 上方时调用。
OnMouseOver当鼠标悬停在 GUIElement 或 Collider 上时，每帧调用一次。
OnMouseUp当用户松开鼠标按钮时，将调用 OnMouseUp。
OnMouseUpAsButton松开鼠标时，仅当鼠标在按下时所在的 GUIElement 或 Collider 上时，才调用 OnMouseUpAsButton。
OnNetworkInstantiate在已通过 Network.Instantiate 进行网络实例化的对象上调用。
OnParticleCollision当粒子击中碰撞体时，将调用 OnParticleCollision。
OnParticleSystemStopped系统中的所有粒子都死亡时，便会调用 OnParticleSystemStopped，然后将不再产生新粒子。在调用 Stop 之后，或者超过非循环系统的 Duration 属性时，将停止产生新粒子。
OnParticleTrigger当粒子系统中的任何粒子满足触发模块中的条件时，将调用 OnParticleTrigger。
OnPlayerConnected每当有新玩家成功连接，就在服务器上调用。
OnPlayerDisconnected每当有玩家与服务器断开连接，就在服务器上调用。
OnPostRender在摄像机完成场景渲染后，将调用 OnPostRender。
OnPreCull在摄像机剔除场景前，将调用 OnPreCull。
OnPreRender在摄像机开始渲染场景前，将调用 OnPreRender。
OnRenderImageOnRenderImage 在图像的所有渲染操作全部完成后调用。
OnRenderObject在摄像机渲染场景后，将调用 OnRenderObject。
OnSerializeNetworkView用于在网络视图监视的脚本中自定义变量同步。
OnServerInitialized每当调用 Network.InitializeServer 并且完成时，对该服务器调用该函数。
OnTransformChildrenChanged当 GameObject 的变换的子项列表发生更改时，将调用该函数。
OnTransformParentChanged当 GameObject 的变换的父属性发生更改时，将调用该函数。
OnTriggerEnter GameObject 与另一 GameObject 碰撞时，将调用 OnTriggerEnter。
OnTriggerEnter2D当另一个对象进入附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerExit当 Collider other 已停止接触该触发器时调用 OnTriggerExit。
OnTriggerExit2D当另一个对象离开附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerStay对于接触触发器的每一个 Collider /other/，每次物理更新调用一次 OnTriggerStay。
OnTriggerStay2D在另一个对象位于附加到该对象的触发碰撞体之内时发送每个帧（仅限 2D 物理）。
OnValidate加载脚本后或 Inspector 中的值发生更改时，将调用该函数（只能在 Editor 中调用）。
OnWillRenderObject如果对象可见并且不是 UI 元素，则为每个摄像机调用 OnWillRenderObject。
Reset重置为默认值。
Start在首次调用任何 Update 方法之前启用脚本时，在帧上调用 Start。
Update如果启用了 MonoBehaviour，则每帧调用 Update。
Copyright © 2023 Unity Technologies
优美缔软件（上海）有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961