Build Game Docs
2. Scene の定義と Scene 変数
Scene はゲームの場面をまとめる器です。この章では Scene が何を持っていて、オブジェクト追加や描画順変更、共有変数の管理をどう行うかを見ます。
Scene が持つ基本データ
Scene は主に objects と vars を持ちます。objects はその Scene に属するオブジェクトの一覧で、vars はその Scene 全体で共有したい値を入れる場所です。
objects: プレイヤー、敵、弾、背景、UI など、その Scene に出る全オブジェクトを入れます。vars: スコア、残り時間、ボスのパターン名のように、1体ではなく Scene 全体で共有する値を入れます。_pendingAdds: 更新中に追加されたオブジェクトの待機列です。_isUpdating: 今まさに更新中かどうかを示す内部フラグです。
const mainScene = new Scene();
mainScene.vars.score = 0;
mainScene.vars.phaseName = "Opening";
Game.currentScene には、ここで作った Scene のうち「今アクティブなもの」が入ります。つまり mainScene を Game.setScene(mainScene) した後は、他のオブジェクトから Game.currentScene.vars や Game.currentScene.objects を参照できるようになります。
Scene の主要関数
Scene.constructor()
空の Scene を作ります。ここで objects は空配列、vars は空オブジェクトとして用意されます。
- 引数: なし。
- 戻り値: 新しい
Sceneインスタンス。 - 使いどころ: タイトル画面、本編、結果画面など、場面ごとに 1 つずつ作るのが基本です。
Scene.add(obj, options = {})
オブジェクトを Scene へ登録します。登録されたオブジェクトは、この Scene がアクティブな間、更新と描画の対象になります。
obj: 追加したいGameObjectインスタンスです。options: 追加方法のオプションを入れるオブジェクトです。options.defer:trueなら、更新中に呼ばれた時に即追加せず、待機列へ回します。- 戻り値: 追加した
obj自身を返します。
copyObject() は内部でこの関数を { defer: true } 付きで使い、更新中の安全な追加を実現しています。
Scene.reorder(obj, command)
Scene 内の配列順を変更して、描画順を調整します。後ろにあるものほど手前に描かれます。
obj: 並び順を変えたいオブジェクトです。command: 並び替え方法です。"front"は最前面、"back"は最背面、"up"は一段前、"down"は一段後ろです。- 戻り値: なし。
通常は bringToFront() と sendToBack() から間接的に使うことが多いです。
Scene.update(dt)
Scene にいる全オブジェクトを更新します。未出現オブジェクトなら最初に spawn() を 1 回だけ呼び、その後 update(dt) を呼びます。最後に破棄済みオブジェクトを除去し、待機中の追加を反映します。
dt: 前フレームからの経過秒数です。- 戻り値: なし。
Scene の安全性の中心にある関数で、_isUpdating と _pendingAdds を使って配列の途中変更を防ぎます。
Scene.draw(ctx)
Scene 内に残っているオブジェクトを順番に描画します。ここではロジックを進めず、見た目だけを処理します。
ctx: Canvas の 2D 描画コンテキストです。- 戻り値: なし。
描画順は objects の並び順そのものなので、配列順と見た目の前後関係が直結しています。