Unityではイベント関数と呼ばれる特殊な関数があります。これはゲームオブジェクトにアタッチされたスクリプトの中で特別な名前のメソッドがUnityから呼ばれるという機能です。
よく使うものを挙げると、
- Awake()
- Start()
- Update()
- OnDestroy()
などです。
イベント関数を使う上で問題になることが多いのが、名前を間違うことです。名前を間違えただけなので修正は容易なのですが、問題が発覚しにくいことが厄介なところです。
名前を間違っていても特にコンパイルエラーは発生しません。そのためプログラム的な問題はないと判断されて、後になって実は問題があるということになります。Unityから呼び出されなくても文法的には問題ないため、検出できないバグになるのです。
OnCollisionEnter(Collision)みたいに特定のクラスを引数に取る場合も注意が必要です。イベント関数の名前が合っていても引数の型が間違っているということがあります。このときどのようになるかを例を挙げて調べてみました。
void OnCollisionStay(int n)のように定義すると、以下のようにエラーが発生しました。
しかしながら、void OnCollisionStay()というように引数を空にしてみるとイベントが発生したタイミングに正しく呼ばれていました。
つまり、イベント関数が引数を取る場合、引数があっているか空であれば呼ばれるということです。（もちろん名前が合っているとして）
イベント関数の名前を間違ったり、引数の型を間違っていてもエラーが発生しないことがあります。
正しくないイベント関数を書かないようにすることは絶対には防げないので、起こりにくくする方法を紹介することにします。
VSTUを使っている場合は便利機能でイベント関数を自動で実装することができます。これを使うのが最もミスの起こりにくい方法だと思います。あまり詳しくないイベントを使う時などはこの機能を使っておくのが良いです。
Visual Studioでイベント関数を追加したいソースファイルを開いて、ソース上で右クリックをすると下のメニューが現れます。
Implement MonoBehavioursとQuick MonoBehavioursとが用意されているので、どちらかをクリックします。
Implement MonoBehavioursの場合は、次のウィンドウが現れます。
チェックしたイベント関数が一度に追加でき、メソッドの説明をコメントできたりするのでお勧めです。ソースに自動的にプログラムが書かれるので間違うことがなく、積極的に使うべき機能だと思います。
Quick MonoBehavioursの場合は、次の小さなウィンドウが現れます。
入力欄にイベント名を一部でも入れると候補が検索して現れます。候補を選べばメソッドが追加されます。
こちらの機能はイベントの名前を知っている場合、素早く追加することができるという熟練者向けの機能と言えます。一度に追加できるのは1つまでです。
VSTUを使って自動的に追加されたイベント関数にはpublic void Awake()のようにpublicが付きますが、publicはなくても問題ありません。