イベント関数の特徴
最終更新：
orika_ex_miyako 2025年02月10日(月) 11:42:44履歴
Unity で用意されている、ライフサイクル用のイベント関数について説明します。
各メソッドの実行前提として、同じメソッドが複数ある場合、その実行順序は保証されません。
例えば Awake メソッドが３つのスクリプトに記述されている場合、ゲーム実行のたびにどのスクリプトの Awake メソッドから実行されるかは指定できません。
よって、実行順位に依存しない処理を記述するか、手動で実行順位を設定するか、いずれかの対処が必要になります。
１．Awake メソッド
・ゲーム実行時、Awake メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトがアクティブである場合、１回実行される。
・ゲーム実行時、Awake メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトが非アクティブである場合、このタイミングでは実行されない。
ゲーム内において、ゲームオブジェクトがアクティブになったタイミングで１回実行される。
・Awake メソッドが記述されているスクリプトが非アクティブ状態であっても、ゲームオブジェクトがアクティブであれば実行される。
https://docs.unity3d.com/ja/current/ScriptReferenc...
２．OnEnable メソッド
３．Reset メソッド
４．Start メソッド
・ゲーム実行時、Start メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトがアクティブである場合、１回実行される。
・ゲーム実行時、Start メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトが非アクティブである場合、このタイミングでは実行されない。
ゲーム内において、ゲームオブジェクトがアクティブになったタイミングで１回実行される。
・Awake メソッドとは異なり、Start メソッドが記述されているスクリプトが非アクティブ状態であれば、ゲームオブジェクトがアクティブであっても実行されない。
こちらに詳細な説明記事があります。
Awake メソッドや Start メソッドは複数用意せず、エンジニア側が順序立てて、その順番通りに処理を動かせる設計にしましょう。
→ ２Ｄタワーディフェンス 手順３０
https://docs.unity3d.com/ja/current/ScriptReferenc...
５．OnDisable メソッド
６．OnDestroy メソッド
７．非同期メソッド化できるメソッド
以下のイベントメソッドは、戻り値 void を IEnumelator に書き換えることで、非同期処理できるコルーチンメソッドとして機能させることができます。
Start メソッドが有名ですが、OnCollision 系なども非同期処理にできます。
これは例えば、接触判定後に 0.5秒経ってから SE を鳴らしたり、エフェクトを表示させるなど、うまく活用することで演出面の処理を実装する際に役立ちます。
注意点ですが、Visual Studio などのインテリセンス機能を利用している場合、System.Collections.IEnumerator ではなく、
System.Collections.Generic.IEnumerator<T> を参照してしまう場合があり、その場合にはインテリセンスの候補として下記のメソッドが表示されません。
System.Collections.IEnumerator を参照すれば、正しくインテリセンスの候補に表示され、コルーチンメソッド化できます。
＜アルファベット順＞
参考サイト
Unity 公式マニュアル
イベント関数の実行順序
各メソッドの実行前提として、同じメソッドが複数ある場合、その実行順序は保証されません。
例えば Awake メソッドが３つのスクリプトに記述されている場合、ゲーム実行のたびにどのスクリプトの Awake メソッドから実行されるかは指定できません。
よって、実行順位に依存しない処理を記述するか、手動で実行順位を設定するか、いずれかの対処が必要になります。
１．Awake メソッド 
・ゲーム実行時、Awake メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトがアクティブである場合、１回実行される。
・ゲーム実行時、Awake メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトが非アクティブである場合、このタイミングでは実行されない。
ゲーム内において、ゲームオブジェクトがアクティブになったタイミングで１回実行される。
・Awake メソッドが記述されているスクリプトが非アクティブ状態であっても、ゲームオブジェクトがアクティブであれば実行される。
https://docs.unity3d.com/ja/current/ScriptReferenc...
２．OnEnable メソッド
３．Reset メソッド
４．Start メソッド
・ゲーム実行時、Start メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトがアクティブである場合、１回実行される。
・ゲーム実行時、Start メソッドが記述されているスクリプトがアタッチされているゲームオブジェクトが非アクティブである場合、このタイミングでは実行されない。
ゲーム内において、ゲームオブジェクトがアクティブになったタイミングで１回実行される。
・Awake メソッドとは異なり、Start メソッドが記述されているスクリプトが非アクティブ状態であれば、ゲームオブジェクトがアクティブであっても実行されない。
こちらに詳細な説明記事があります。
Awake メソッドや Start メソッドは複数用意せず、エンジニア側が順序立てて、その順番通りに処理を動かせる設計にしましょう。
→ ２Ｄタワーディフェンス 手順３０
https://docs.unity3d.com/ja/current/ScriptReferenc...
５．OnDisable メソッド
６．OnDestroy メソッド
７．非同期メソッド化できるメソッド
以下のイベントメソッドは、戻り値 void を IEnumelator に書き換えることで、非同期処理できるコルーチンメソッドとして機能させることができます。
Start メソッドが有名ですが、OnCollision 系なども非同期処理にできます。
これは例えば、接触判定後に 0.5秒経ってから SE を鳴らしたり、エフェクトを表示させるなど、うまく活用することで演出面の処理を実装する際に役立ちます。
注意点ですが、Visual Studio などのインテリセンス機能を利用している場合、System.Collections.IEnumerator ではなく、
System.Collections.Generic.IEnumerator<T> を参照してしまう場合があり、その場合にはインテリセンスの候補として下記のメソッドが表示されません。
System.Collections.IEnumerator を参照すれば、正しくインテリセンスの候補に表示され、コルーチンメソッド化できます。
＜アルファベット順＞
・OnAnimatorIK ・OnAnimatorMove ・OnApplicationFocus ・OnApplicationPause ・OnApplicationQuit ・OnAudioFilterRead ・OnBecameInvisible ・OnBecameVisible ・OnBeforeTransformParentChanged ・OnCanvasGroupChanged ・OnCollisionEnter / OnCollisionEnter2D ・OnCollisionExit / OnCollisionExit2D ・OnCollisionStay / OnCollisionStay2D ・OnControllerColliderHit ・OnDrawGizmosSelected ・OnJointBreak / OnJointBreak2D ・OnLevelWasLoaded ・OnMouseDown ・OnMouseDrag ・OnMouseEnter ・OnMouseExit ・OnMouseOver ・OnMouseUp ・OnMouseUpAsButton ・OnParticleCollision ・OnParticleSystemStopped ・OnParticleTrigger ・OnParticleUpdateJobScheduled ・OnPostRender ・OnPreCull ・OnPreRender ・OnRectTransformDimensionsChange ・OnRectTransformRemoved ・OnRenderImage ・OnServerInitialized ・OnTransformChildrenChanged ・OnTransformParentChanged ・OnTriggerEnter / OnTriggerEnter2D ・OnTriggerExit / OnTriggerExit2D ・OnTriggerStay / OnTriggerStay2D ・OnWillRenderObject ・Reset ・Start
参考サイト
Hatena Blog はっち 様
【Unity】Monobehaviour 継承クラスで利用できる UnityEvent 一覧
コメントをかく