BaseInputModule

class in UnityEngine.EventSystems

Description

Базовый модуль, вызывающий события и отправляющий их игровому объекту GameObjects.

Входной модуль (Input Module) это компоненты системы событий (EventSystem), отвечающий за вызов событий и отправление их игровым объектам (GameObjects) для обработки. BaseInputModule это класс, из которого наследуются все входные модули системы событий. Например, модули 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);
    }
}

Variables

input

The current BaseInput being used by the input module.

Public Functions

ActivateModule	Вызывается когда модуль активирован. Перезаписывается, если вы хотите использовать свой код для активации модуля.
DeactivateModule	Вызывается когда модуль деактивирован. Перезаписывается если вы хотите использовать свой код для деактивации модуля.
IsModuleSupported	Проверьте, поддерживается ли модуль. Перезаписывается если у вас специфическая платформа для модуля (например TouchInputModule) и вы не хотите активирование на standalone.
IsPointerOverGameObject	Is the pointer with the given ID over an EventSystem object?
Process	Обработка текущей отметки для модуля.
ShouldActivateModule	Должен быть активирован.
UpdateModule	Обновление внутреннего состояния модуля.

Protected Functions

GetAxisEventData	Учитывает некоторые входные данные, сгенерированные AxisEventData, которые могут быть использованы системой событий.
GetBaseEventData	Генерирует BaseEventData, который может использоваться системой событий.
HandlePointerExitAndEnter	Обработчик, отправляющий входные и выходные события при обнаружении новой входной цели.
OnDisable	См. MonoBehaviour.OnDisable.
OnEnable	См. MonoBehaviour.OnEnable.

Static Functions

DetermineMoveDirection	Учитывает направление входа, определенный лучшим MoveDirection.
FindCommonRoot	Учитывает 2 GameObject возвращающий общие корни GameObject (или null).
FindFirstRaycast	Возвращает первое значение RaycastResult.

Inherited members

Variables

enabled	Включенное Поведение обновляется, выключенное Поведение не обновляется.
isActiveAndEnabled	Has the Behaviour had enabled called.
gameObject	Игровой объект к которому прикреплён данный компонент. Компонент всегда прикреплён к игровому объекту.
tag	Тег данного игрового объекта.
transform	The Transform attached to this GameObject.
runInEditMode	Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).
useGUILayout	Disabling this lets you skip the GUI layout phase.
hideFlags	Should the object be hidden, saved with the scene or modifiable by the user?
name	The name of the object.

Public Functions

BroadcastMessage	Вызывает метод названный methodName на каждом MonoBehaviour этого game object-а или любого из его потомков.
CompareTag	Помечен ли данный игровой объект тегом tag?
GetComponent	Возвращает компонент типа type, если он прикреплен к игровому объекту и null, если не прикреплен.
GetComponentInChildren	Возвращает компонент типа type в GameObject или некоторого его потомка через поиск в глубину.
GetComponentInParent	Возвращает все компоненты типа type из GameObject'а или из любого его родителя.
GetComponents	Возвращает все компоненты типа type в GameObject.
GetComponentsInChildren	Возвращает все компоненты типа type в GameObject или любому из его потомков.
GetComponentsInParent	Возвращает все компоненты типа type в GameObject или любому из его родителей.
SendMessage	Вызывает метод с названием methodName в каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwards	Вызывает метод с именем methodName в каждом MonoBehaviour в этом игровом объекте и в каждом предке поведения.
CancelInvoke	Отменяет все вызовы Invoke в этом MonoBehaviour.
Invoke	Вызывает метод methodName по истечении времени time секунд.
InvokeRepeating	Вызывает метод methodName по истечении времени time секунд, затем повторяет вызов каждые repeatRate секунд.
IsInvoking	Есть ли какой то ожидающий вызов methodName?
StartCoroutine	Запуск корутины.
StopAllCoroutines	Останавливает все корутины запущенные на этом MonoBehaviour.
StopCoroutine	Останавливает все корутины с именем methodName запущенные на этом MonoBehaviour.
GetInstanceID	Returns the instance id of the object.
ToString	Returns the name of the game object.
IsActive	Возвращает true если GameObject и Component активны.
IsDestroyed	Возвращает true если родное представление поведения было разрушено.

Protected Functions

Awake	См. MonoBehaviour.Awake.
OnBeforeTransformParentChanged	См. MonoBehaviour.OnBeforeTransformParentChanged.
OnCanvasGroupChanged	См. MonoBehaviour.OnCanvasGroupChanged.
OnCanvasHierarchyChanged	Called when the state of the parent Canvas is changed.
OnDestroy	См. MonoBehaviour.OnDestroy.
OnDidApplyAnimationProperties	См. MonoBehaviour.OnDidApplyAnimationProperties.
OnRectTransformDimensionsChange	This callback is called if an associated RectTransform has its dimensions changed. The call is also made to all child rect transforms, even if the child transform itself doesn't change - as it could have, depending on its anchoring.
OnTransformParentChanged	См. MonoBehaviour.OnRectTransformParentChanged.
OnValidate	См. MonoBehaviour.OnValidate.
Reset	См. MonoBehaviour.Reset.
Start	См. MonoBehaviour.Start.

Static Functions

print	Logs message to the Unity Console (identical to Debug.Log).
Destroy	Удаляет GameObject, Component или Asset.
DestroyImmediate	Destroys the object obj immediately.
DontDestroyOnLoad	Makes the object target not be destroyed automatically when loading a new scene.
FindObjectOfType	Returns the first active loaded object of Type type.
FindObjectsOfType	Returns a list of all active loaded objects of Type type.
Instantiate	Clones the object original and returns the clone.

Operators

bool	Does the object exist?
operator !=	Compares if two objects refer to a different object.
operator ==	Compares two object references to see if they refer to the same object.

Messages

Awake	Функция Awake вызывается когда экземпляр скрипта будет загружен.
FixedUpdate	Эта функция вызывается с частотой фиксированных кадров (fixed framerate), если MonoBehaviour включен.
LateUpdate	LateUpdate вызывается каждый кадр, если Behaviour включен.
OnAnimatorIK	Обратный вызов (Callback) для установки IK анимации (инверсной кинематики).
OnAnimatorMove	Обратный вызов для обработки перемещения анимации для модификации смещения корня.
OnApplicationFocus	Посылается ко всем игровым объектам когда плейер получает или теряет фокус.
OnApplicationPause	Посылается ко всем игровым объектам когда плейер на паузе.
OnApplicationQuit	Sent to all game objects before the application is quit.
OnAudioFilterRead	If OnAudioFilterRead is implemented, Unity will insert a custom filter into the audio DSP chain.
OnBecameInvisible	OnBecameInvisible is called when the renderer is no longer visible by any camera.
OnBecameVisible	OnBecameVisible is called when the renderer became visible by any camera.
OnCollisionEnter	OnCollisionEnter вызывается, когда этот collider/rigidbody начал соприкосновение с другим rigidbody/collider.
OnCollisionEnter2D	Передается когда входящий коллайдер контактирует с коллайдером данного объекта (только 2D физика).
OnCollisionExit	OnCollisionExit вызывается, когда collider/rigidbody прекращает контакт с другим rigidbody/collider.
OnCollisionExit2D	Передается, когда коллайдер другого объекта перестает соприкасаться с коллайдером этого объекта (только 2D физика).
OnCollisionStay	OnCollisionStay вызывается один раз в кадр для каждого collider/rigidbody, который касается другого rigidbody/collider.
OnCollisionStay2D	Передается каждый кадр, пока коллайдер другого объекта контактирует с коллайдером данного объекта (только 2D физика).
OnConnectedToServer	Called on the client when you have successfully connected to a server.
OnControllerColliderHit	OnControllerColliderHit вызывается тогда, когда контроллер сталкивается с коллайдеров, во время выполнения метода Move.
OnDestroy	This function is called when the MonoBehaviour will be destroyed.
OnDisconnectedFromServer	Called on the client when the connection was lost or you disconnected from the server.
OnDrawGizmos	Implement OnDrawGizmos if you want to draw gizmos that are also pickable and always drawn.
OnDrawGizmosSelected	Implement OnDrawGizmosSelected to draw a gizmo if the object is selected.
OnFailedToConnect	Called on the client when a connection attempt fails for some reason.
OnFailedToConnectToMasterServer	Called on clients or servers when there is a problem connecting to the MasterServer.
OnGUI	OnGUI is called for rendering and handling GUI events.
OnJointBreak	Вызывается при разрушении сустава, прикрепленного к такому же игровому объекту.
OnJointBreak2D	Called when a Joint2D attached to the same game object breaks.
OnMasterServerEvent	Called on clients or servers when reporting events from the MasterServer.
OnMouseDown	OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDrag	OnMouseDrag is called when the user has clicked on a GUIElement or Collider and is still holding down the mouse.
OnMouseEnter	Called when the mouse enters the GUIElement or Collider.
OnMouseExit	Called when the mouse is not any longer over the GUIElement or Collider.
OnMouseOver	Called every frame while the mouse is over the GUIElement or Collider.
OnMouseUp	OnMouseUp is called when the user has released the mouse button.
OnMouseUpAsButton	OnMouseUpAsButton is only called when the mouse is released over the same GUIElement or Collider as it was pressed.
OnNetworkInstantiate	Called on objects which have been network instantiated with Network.Instantiate.
OnParticleCollision	OnControllerColliderHit вызывается тогда, когда контроллер сталкивается с коллайдеров, во время выполнения метода Move.
OnParticleTrigger	OnParticleTrigger is called when any particles in a particle system meet the conditions in the trigger module.
OnPlayerConnected	Called on the server whenever a new player has successfully connected.
OnPlayerDisconnected	Called on the server whenever a player disconnected from the server.
OnPostRender	OnPostRender is called after a camera finished rendering the scene.
OnPreCull	OnPreCull вызывается до того, как камера отсечёт сцену.
OnPreRender	OnPreRender вызывается перед тем, как камера начнёт рендерить сцену.
OnRenderImage	OnRenderImage вызывается после того как весь рендеринг для отрисовки изображения завершиться.
OnRenderObject	OnRenderObject вызывается после того, как камера отрендерила сцену.
OnSerializeNetworkView	Used to customize synchronization of variables in a script watched by a network view.
OnServerInitialized	Called on the server whenever a Network.InitializeServer was invoked and has completed.
OnTransformChildrenChanged	This function is called when the list of children of the transform of the GameObject has changed.
OnTransformParentChanged	This function is called when the parent property of the transform of the GameObject has changed.
OnTriggerEnter	OnTriggerEnter вызывается, когда Collider other входит в триггер.
OnTriggerEnter2D	Передается, когда другой обьект входит в триггер присоединенный к данному обьекту (только 2D физика).
OnTriggerExit	OnTriggerExit вызывается, когда Collider other перестает соприкасаться с триггером.
OnTriggerExit2D	Передается когда другой объект покидает триггер, присоединенный к данному объекту(только 2D физика).
OnTriggerStay	OnTriggerStay is called once per frame for every Collider other that is touching the trigger.
OnTriggerStay2D	Передается каждый кадр, пока другой объект находится в триггере, присоединенном к этому объекту (только 2D физика).
OnValidate	Эта функция вызывается когда скрипт загружается или изменяется значение в Инспекторе (Вызывается только в редакторе).
OnWillRenderObject	OnWillRenderObject вызвается один раз для каждой камеры, если объект в зоне видимости.
Reset	Reset to default values.
Start	Start is called on the frame when a script is enabled just before any of the Update methods is called the first time.
Update	Update вызывается каждый кадр, если MonoBehaviour включен.

Scripting API

BaseInputModule

Description

Variables

Public Functions

Protected Functions

Static Functions

Inherited members

Variables

Public Functions

Protected Functions

Static Functions

Operators

Messages