Классы для скриптовых систем, доступных функций и событий в Unity

Классы охватывают некоторые основные области скриптовых систем Unity и являются хорошей отправной точкой для поиска доступных функций и событий. Здесь некоторые из наиболее важных классов, которые вы будете использовать при написании сценариев в Unity.

 

Учебный класс:	Описание:
MonoBehaviour	Справочник MonoBehaviour, базовый класс для всех новых сценариев Unity, предоставляет вам список всех функций и событий, доступных для стандартных сценариев, прикрепленных к игровым объектам. Начните здесь, если вы ищете какое-либо взаимодействие или контроль над отдельными объектами в вашей игре.
преобразование	Каждый игровой объект имеет позицию, вращение и масштаб в пространстве (будь то 3D или 2D), и это представлено компонентом Transform. Помимо предоставления этой информации, компонент преобразования имеет много полезных функций, которые можно использовать для перемещения, масштабирования, поворота, повторного отображения и управления объектами, а также для преобразования координат из одного пространства в другое.
Rigidbody / Rigidbody2D	Для большинства элементов игрового процесса физический движок предоставляет самый простой набор инструментов для перемещения объектов, обнаружения триггеров и столкновений, а также применения сил. Класс Rigidbody (или его 2D-эквивалент, Rigidbody2D) предоставляет все свойства и функции, которые вам необходимы для работы со скоростью, массой, сопротивлением, силой, крутящим моментом, столкновением и многим другим.

12

MonoBehaviour

class in UnityEngine

/

Наследует от:Behaviour

Описание

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

При использовании Javascript каждый скрипт автоматически наследуется от MonoBehaviour. Когда используется C# или Boo Вам необходимо явно наследоваться от MonoBehaviour.

Примечание: Флажок выключающий MonoBehavior (в редакторе) будет только предотвращать выполнение функций Start(), Awake(), Update(), FixedUpdate(), и OnGUI(). Если ни одной из этих функций в скрипте не присутствует - флажок не отображается.

See Also: главу по скриптингу в мануале.

Переменные

useGUILayout

Disabling this lets you skip the GUI layout phase.

Открытые функции

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

Статические функции

print

Logs message to the Unity Console (identical to Debug.Log).

Сообщения

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.
OnDisable	This function is called when the behaviour becomes disabled () or inactive.
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 this OnDrawGizmosSelected if you want to draw  gizmos only if the object is selected.
OnEnable	This function is called when the object becomes enabled and active.
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	Вызывается при разрушении сустава, прикрепленного к такому же игровому объекту.
OnLevelWasLoaded	This function is called after a new level was loaded.
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	OnParticleCollision is called when a particle hits a collider.
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 включен.

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

Переменные

enabled	Enabled Behaviours are Updated, disabled Behaviours are  not.
isActiveAndEnabled	Has the Behaviour had enabled called.
gameObject	The game object this component is attached to. A component  is always attached to a game object.
tag	Тег данного игрового объекта.
transform	The Transform attached to this GameObject (null if there is none attached).
hideFlags	Should the object be hidden, saved with the scene or modifiable by the user?
name	The name of the object.

Открытые функции

BroadcastMessage	Вызывает метод названный methodName на каждом MonoBehaviour этого game object-а или любого из его потомков.
CompareTag	Помечен ли этот игровой объект тэгом tag?
GetComponent	Возвращает компонент типа type, если он прикреплен  к игровому объекту и null, если не прикреплен.
GetComponentInChildren	Returns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParent	Returns the component of Type type in the GameObject or any of its parents.
GetComponents	Returns all components of Type type in the GameObject.
GetComponentsInChildren	Returns all components of Type type in the GameObject or any of its children.
GetComponentsInParent	Returns all components of Type type in the GameObject or any of its parents.
SendMessage	Вызывает метод с именем methodName в каждом MonoBehaviour на этом объекте.
SendMessageUpwards	Вызывает на каждом MonoBehaviour в данном игровом объекте и на каждом предке скрипта метод с именем methodName.
GetInstanceID	Returns the instance id of the object.
ToString	Returns the name of the game object.

Статические функции

Destroy	Removes a gameobject, component or asset.
DestroyImmediate	Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
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	Returns a copy of the object original.

Операторы

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.