Мои Уведомления
Привет, !
Мой Аккаунт Мои Финансы Мои Подписки Мои Настройки Выход
Руководство API скрипты
к Руководству

MonoBehaviour

класс в UnityEngine / Наследует от: Behaviour / Реализовано в: UnityEngine.CoreModule

Описание

MonoBehaviour — это базовый класс, от которого наследуется каждый скрипт Unity.

При использовании C# вы должны явно наследоваться от MonoBehaviour.

Этот класс не поддерживает нулевой условный оператор (?.) и нулевой оператор объединения (??).

Примеры кода см. в отдельных методах MonoBehaviour.

Примечание. В редакторе Unity есть флажок для включения или отключения MonoBehaviour. Он отключает работает, если флажок не установлен. Если в сценарии нет ни одной из этих функций, редактор Unity не отобразить флажок. Функции:

Смотрите так же: Страница Деактивация игровых объектов в руководстве.

Свойства

runInEditMode Разрешить запуск определенного экземпляра MonoBehaviour в режиме редактирования (доступно только в редакторе).
useGUILayout Отключение этого параметра позволяет пропустить фазу компоновки графического интерфейса.

Публичные Методы

CancelInvoke Отменяет все вызовы Invoke для этого MonoBehaviour.
Invoke Вызывает метод methodName в секундах.
InvokeRepeating Вызывает метод methodName в секундах времени, а затем повторно через каждые RepeatRate секунд.
IsInvoking Отложен ли какой-либо вызов для methodName?
StartCoroutine Запускает сопрограмму.
StopAllCoroutines Остановка всех сопрограмм, работающих при таком поведении.
StopCoroutine Остановка первой сопрограммы с именем methodName или сопрограммы, хранящейся в подпрограмме, работающей с этим поведением.

Статические Методы

print Записывает сообщение в консоль Unity (идентично Debug.Log).

Сообщения

Awake Awake вызывается при загрузке экземпляра скрипта.
FixedUpdate Независимое от частоты кадров сообщение MonoBehaviour.FixedUpdate для физических расчетов.
LateUpdate LateUpdate вызывается в каждом кадре, если Behavior включен.
OnAnimatorIK Обратный вызов для настройки анимации ИК (инверсной кинематики).
OnAnimatorMove Обратный вызов для обработки движений анимации для изменения корневого движения.
OnApplicationFocus Отправляется всем GameObjects, когда игрок получает или теряет фокус.
OnApplicationPause Отправляется всем GameObjects, когда приложение приостанавливается.
OnApplicationQuit Отправляется на все игровые объекты перед закрытием приложения.
OnAudioFilterRead Если реализован OnAudioFilterRead, Unity вставит пользовательский фильтр в цепочку аудио DSP.
OnBecameInvisible OnBecameInvisible вызывается, когда средство визуализации больше не видно ни одной камере.
OnBecameVisible OnBecameVisible вызывается, когда средство визуализации становится видимым для любой камеры.
OnCollisionEnter OnCollisionEnter вызывается, когда этот коллайдер(collider.)/твердое тело(rigidbody.) начинает касаться другого твердого тела/коллайдера.
OnCollisionEnter2D Отправляется, когда входящий коллайдер вступает в контакт с коллайдером этого объекта (только 2D-физика).
OnCollisionExit OnCollisionExit вызывается, когда этот коллайдер/твёрдое тело перестал касаться другого твердого тела/коллайдера.
OnCollisionExit2D Отправляется, когда коллайдер другого объекта перестает касаться коллайдера этого объекта (только для 2D-физики).
OnCollisionStay OnCollisionStay вызывается один раз за кадр для каждого коллайдера/твёрдого тела, которое соприкасается с твердым телом/коллайдером.
OnCollisionStay2D Отправляется каждый кадр, в котором коллайдер другого объекта касается коллайдера этого объекта (только 2D-физика).
OnConnectedToServer Вызывается на клиенте, когда вы успешно подключились к серверу.
OnControllerColliderHit OnControllerColliderHit вызывается, когда контроллер сталкивается с коллайдером при выполнении Move.
OnDestroy Уничтожение прикрепленного Behavior приведет к тому, что игра или сцена получат OnDestroy.
OnDisable Эта функция вызывается, когда поведение отключается.
OnDisconnectedFromServer Вызывается на клиенте, когда соединение было потеряно или вы отключились от сервера.
OnDrawGizmos Реализуйте OnDrawGizmos, если вы хотите рисовать гизмо, которые также можно выбрать и рисовать.
OnDrawGizmosSelected Реализуйте OnDrawGizmosSelected для рисования гизмо, если объект выбран.
OnEnable Эта функция вызывается, когда объект становится включенным и активным.
OnFailedToConnect Вызывается на клиенте, когда попытка подключения по какой-то причине не удалась.
OnFailedToConnectToMasterServer Вызывается на клиентах или серверах при возникновении проблемы с подключением к MasterServer.
OnGUI OnGUI вызывается для рендеринга и обработки событий GUI.
OnJointBreak Вызывается, когда сломалось соединение, прикрепленное к тому же игровому объекту.
OnJointBreak2D Вызывается при разрыве соединения Joint2D, прикрепленного к тому же игровому объекту.
OnMasterServerEvent Вызывается на клиентах или серверах при сообщении о событиях с MasterServer.
OnMouseDown OnMouseDown вызывается, когда пользователь нажимает кнопку мыши над коллайдером.
OnMouseDrag OnMouseDrag вызывается, когда пользователь щелкнул коллайдер и все еще удерживает мышь.
OnMouseEnter Вызывается, когда мышь входит в коллайдер.
OnMouseExit Вызывается, когда мышь больше не находится над коллайдером.
OnMouseOver Вызывается каждый кадр, пока мышь находится над коллайдером.
OnMouseUp OnMouseUp вызывается, когда пользователь отпускает кнопку мыши.
OnMouseUpAsButton OnMouseUpAsButton вызывается только тогда, когда мышь отпускается над тем же коллайдером, в котором она была нажата.
OnNetworkInstantiate Вызывается для объектов, которые были созданы в сети с помощью Network.Instantiate.
OnParticleCollision OnParticleCollision вызывается, когда частица сталкивается с коллайдером.
OnParticleSystemStopped OnParticleSystemStopped вызывается, когда все частицы в системе умерли и новые частицы рождаться не будут. Новые частицы перестают создаваться либо после вызова Stop, либо при превышении свойства продолжительности незацикленной системы.
OnParticleTrigger OnParticleTrigger вызывается, когда какие-либо частицы в системе частиц соответствуют условиям в модуле триггера.
OnParticleUpdateJobScheduled OnParticleUpdateJobScheduled вызывается, когда запланировано встроенное задание обновления системы частиц.
OnPlayerConnected Вызывается на сервере всякий раз, когда новый игрок успешно подключается.
OnPlayerDisconnected Вызывается на сервере всякий раз, когда игрок отключается от сервера.
OnPostRender Функция события, которую Unity вызывает после рендеринга сцены камерой.
OnPreCull Функция события, которую Unity вызывает перед тем, как камера выберет сцену.
OnPreRender Функция события, которую Unity вызывает перед визуализацией сцены камерой.
OnRenderImage Функция события, которую Unity вызывает после завершения рендеринга камеры, что позволяет вам изменить финальное изображение с камеры.
OnRenderObject OnRenderObject вызывается после того, как камера визуализирует сцену.
OnSerializeNetworkView Используется для настройки синхронизации переменных в сценарии, отслеживаемом сетевым представлением.
OnServerInitialized Вызывается на сервере при каждом вызове и завершении Network.InitializeServer.
OnTransformChildrenChanged Эта функция вызывается при изменении списка дочерних элементов трансформации GameObject.
OnTransformParentChanged Эта функция вызывается при изменении прямого или косвенного родителя преобразования GameObject.
OnTriggerEnter Когда GameObject сталкивается с другим GameObject, Unity вызывает OnTriggerEnter.
OnTriggerEnter2D Отправляется, когда другой объект входит в триггерный коллайдер, прикрепленный к этому объекту (только для 2D-физики).
OnTriggerExit OnTriggerExit вызывается, когда другой коллайдер перестал касаться триггера.
OnTriggerExit2D Отправляется, когда другой объект покидает триггерный коллайдер, прикрепленный к этому объекту (только для 2D-физики).
OnTriggerStay OnTriggerStay вызывается один раз для обновления физики для каждого другого коллайдера, который касается триггера.
OnTriggerStay2D Отправляется каждый кадр, в котором другой объект находится внутри триггерного коллайдера, прикрепленного к этому объекту (только 2D-физика).
OnValidate Функция только для редактора, которую Unity вызывает при загрузке скрипта или изменении значения в Инспекторе.
OnWillRenderObject OnWillRenderObject вызывается для каждой камеры, если объект виден, а не является элементом пользовательского интерфейса.
Reset Сбросить значения по умолчанию.
Start Start вызывается во фрейме, когда скрипт включается непосредственно перед первым вызовом любого из методов Update.
Update Обновление вызывается каждый кадр, если включен MonoBehaviour.

Унаследованные члены

Свойства

enabled Включенные поведения обновляются, отключенные — нет.
isActiveAndEnabled Было ли поведение активным и включенным?
gameObject Игровой объект, к которому прикреплен компонент. Компонент всегда привязан к игровому объекту.
tag Тег игрового объекта.
transform Transform, прикрепленный игровому объекту.
hideFlags Должен ли объект быть скрыт, сохранен вместе со сценой или изменен пользователем?
name Имя объекта

Публичные Методы

BroadcastMessage Вызывает метод с именем methodName для каждого MonoBehaviour в игровом объекте или любом из его дочерних элементов.
CompareTag Помечен ли этот игровой объект тегом?
GetComponent Возвращает компонент, если он прикреплён к игровому объекту, и null, если нет. Также возвращает отключенные компоненты.
GetComponentInChildren Возвращает компонент дочернего элемента игрового объекта, используя поиск в глубину.
GetComponentInParent Возвращает компонент игрового объекта в любом из его родителей.
GetComponents Возвращает все компоненты игрового объекта
GetComponentsInChildren Возвращает все компоненты дочерних элементов игрового объекта. Работает рекурсивно.
GetComponentsInParent Возвращает все компоненты игрового объекта любого из родителя.
SendMessage Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте.
SendMessageUpwards Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте и для каждого behaviour.
TryGetComponent Получает компонент указанного типа, если он существует.
GetInstanceID Возвращает идентификатор экземпляра объекта.
ToString Возвращает имя объекта.

Статические Методы

Destroy Удаляет игровой объект, компонент или актив.
DestroyImmediate Уничтожает объект obj. Настоятельно рекомендуется использовать Destroy.
DontDestroyOnLoad Не уничтожает целевой объект при загрузке новой сцены.
FindObjectOfType Возвращает первый активный загруженный объект.
FindObjectsOfType Получает список всех загруженных объектов.
Instantiate Клонирует исходный объект и возвращает клон.

Операторы

bool Объект существует?
operator != Сравнивает, ссылаются ли два объекта на другой объект.
operator == Сравнивает две ссылки на объекты, чтобы определить, ссылаются ли они на один и тот же объект.
Вы можете отблагодарить автора, за перевод документации на русский язык. ₽ Спасибо
API скрипты 2021.3