BaseInputModule

class in UnityEngine.EventSystems

描述

用于引发事件并将其发送到 GameObjects 的基本模块。

输入模块是 EventSystem 的一个组件，负责引发事件并将其发送到 GameObjects 进行处理。BaseInputModule 是一个类，EventSystem 中所有输入模块都继承自该类。提供的模块示例为 TouchInputModule 和 StandaloneInputModule，如果这些模块不适合您的项目，您可以通过从 BaseInputModule 扩展来创建自己的模块。

using UnityEngine;
using UnityEngine.EventSystems;

// Create a module that every tick sends a 'Move' event to
// the target object

public class MyInputModule : BaseInputModule
{
    public GameObject m_TargetObject;

    public override void Process()
    {
        if (m_TargetObject == null)
            return;
        ExecuteEvents.Execute(m_TargetObject, new BaseEventData(eventSystem), ExecuteEvents.moveHandler);
    }
}

变量

input	输入模块使用的当前 BaseInput。
inputOverride	用于覆盖输入模块的默认 BaseInput。

公共函数

ActivateModule	激活模块时调用。如果要在激活模块时执行自定义代码，请覆盖此项。
DeactivateModule	停用模块时调用。如果要在停用模块时执行自定义代码，请覆盖此项。
IsModuleSupported	检查模块是否受支持。如果您有一个平台特定模块（例如 TouchInputModule），但不想在独立平台上激活，请覆盖此项。
IsPointerOverGameObject	具有给定 ID 的指针是否位于 EventSystem 对象上？
Process	处理模块的当前刻度。
ShouldActivateModule	应该被激活。
UpdateModule	更新模块的内部状态。

受保护的函数

GetAxisEventData	提供了一些输入数据，生成事件系统可以使用的 AxisEventData。
GetBaseEventData	生成 EventSystem 可以使用的 BaseEventData。
HandlePointerExitAndEnter	当发现新的输入目标时处理正在发送的进入和退出事件。
OnDisable	请参阅 MonoBehaviour.OnDisable。
OnEnable	请参阅 MonoBehaviour.OnEnable。

静态函数

DetermineMoveDirection	提供了输入移动，确定最佳 MoveDirection。
FindCommonRoot	提供了 2 个 GameObject，返回一个公共根 GameObject（或 null）。
FindFirstRaycast	返回第一个有效 RaycastResult。

继承的成员

变量

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

公共函数

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。

受保护的函数

Awake	请参阅 MonoBehaviour.Awake。
OnBeforeTransformParentChanged	请参阅 MonoBehaviour.OnBeforeTransformParentChanged。
OnCanvasGroupChanged	请参阅 MonoBehaviour.OnCanvasGroupChanged。
OnCanvasHierarchyChanged	在父画布的状态发生更改时调用。
OnDestroy	请参阅 MonoBehaviour.OnDestroy。
OnDidApplyAnimationProperties	请参阅 LayoutGroup.OnDidApplyAnimationProperties。
OnRectTransformDimensionsChange	如果关联的 RectTransform 的尺寸发生更改，则系统会调用此回调。
OnTransformParentChanged	请参阅 MonoBehaviour.OnRectTransformParentChanged。
OnValidate	请参阅 MonoBehaviour.OnValidate。
Reset	请参阅 MonoBehaviour.Reset。
Start	请参阅 MonoBehaviour.Start。

静态函数

print	将消息记录到 Unity 控制台（与 Debug.Log 相同）。
Destroy	删除 GameObject、组件或资源。
DestroyImmediate	立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad	在加载新的 Scene 时，请勿销毁 Object。
FindObjectOfType	返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType	返回所有类型为 type 的已加载的激活对象的列表。
Instantiate	克隆 original 对象并返回克隆对象。

运算符

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

消息

Awake	Awake 在加载脚本实例时调用。
FixedUpdate	用于物理计算且独立于帧率的 MonoBehaviour.FixedUpdate 消息。
LateUpdate	如果启用了 Behaviour，则每帧调用 LateUpdate。
OnAnimatorIK	用于设置动画 IK（反向运动学）的回调。
OnAnimatorMove	用于处理动画移动以修改根运动的回调。
OnApplicationFocus	当玩家获得或失去焦点时，发送给所有 GameObject。
OnApplicationPause	当应用程序暂停时，发送给所有 GameObject。
OnApplicationQuit	在应用程序退出前，发送给所有游戏对象。
OnAudioFilterRead	如果实现了 OnAudioFilterRead，Unity 将在音频 DSP 链中插入一个自定义滤波器。
OnBecameInvisible	OnBecameInvisible 在渲染器对任何摄像机都不可见时调用。
OnBecameVisible	OnBecameVisible 在渲染器变为对任意摄像机可见时调用。
OnCollisionEnter	当该碰撞体/刚体已开始接触另一个刚体/碰撞体时，调用 OnCollisionEnter。
OnCollisionEnter2D	当传入碰撞体与该对象的碰撞体接触时发送（仅限 2D 物理）。
OnCollisionExit	当该碰撞体/刚体已停止接触另一个刚体/碰撞体时，调用 OnCollisionExit。
OnCollisionExit2D	当另一个对象上的碰撞体停止接触该对象的碰撞体时发送（仅限 2D 物理）。
OnCollisionStay	对应正在接触刚体/碰撞体的每一个碰撞体/刚体，每帧调用一次 :ref::OnCollisionStay。
OnCollisionStay2D	在另一个对象上的碰撞体正在接触该对象的碰撞体时发送每个帧（仅限 2D 物理）。
OnConnectedToServer	成功连接到服务器后在客户端上调用。
OnControllerColliderHit	当该控制器在执行 Move 时撞到碰撞体时调用 OnControllerColliderHit。
OnDestroy	销毁附加的行为将导致游戏或场景收到 OnDestroy。
OnDisconnectedFromServer	当连接丢失或与服务器断开连接时，在客户端上调用。
OnDrawGizmos	如果您想绘制能够选择并且始终绘制的辅助图标，则可以实现 OnDrawGizmos。
OnDrawGizmosSelected	如果选择了对象，则实现 OnDrawGizmosSelected 来绘制辅助图标。
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。
OnRenderImage	OnRenderImage 在图像的所有渲染操作全部完成后调用。
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。

脚本 API

BaseInputModule

描述

变量

公共函数

受保护的函数

静态函数

继承的成员

变量

公共函数

受保护的函数

静态函数

运算符

消息