2020-07-02

TopDown Engine 入門 Part 10 ～初期位置編～

プレイヤーキャラクターの初期位置を変える

現状では、プレイヤーキャラクターの初期位置を指定していないので、シーンを再生すると (0, 0, 0) の位置に生成されます。今回は、初期位置を任意の座標に変更していきます。

レベル 1 とレベル 2 のそれぞれで、以下の地点を初期位置にします。

f:id:Gigacee:20200702234815p:plain

チェックポイントを設置

初期位置を任意の座標に設定するためには、その座標にチェックポイントを置く必要があります。

レベル 1 の初期位置は前回作成した PointOfEntry0 と同じ場所ですので、これをそのままチェックポイントにします。Add Component から「Checkpoint」をアタッチしましょう。その後、LevelManager の「Checkpoints」グループ内にある「Initial Spawn Point」に、PointOfEntry0 を設定します。

完了したら、シーンを再生し、プレイヤーキャラクターが PointOfEntry0 の位置に生成されることを確認してください。

レベル 2 の初期位置には何も無いので、新規に GameObject を作成し、「InitialSpawn」とリネームします。その後はレベル 1 と同じです。

補遺

なお、GoToLevelEntryPoint の「Use Entry Points」のチェックを外すと、「Point Of Entry Index」の値が無視され、常に Initial Spawn Point に移動するようになります。

NEXTTopDown Engine 入門 Part 11 ～ルーム編～

PREVTopDown Engine 入門 Part 9 ～シーン遷移編 2～

2020-07-02

TopDown Engine 入門 Part 9 ～シーン遷移編 2～

Unity TopDown Engine

レベル同士のシーン遷移

今回は、異なるシーンで作られたレベル同士を移動できるようにしてみましょう。

「sandbox_level2」というシーンを新しく用意し、以下のようなレベルを作りました。シーンは Build Settings にも忘れずに追加しておきます。

f:id:Gigacee:20200702224744p:plain

これを「レベル 2」とし、今までのレベルは「レベル 1」として扱います。レベル 1 のシーン名を、「sandbox_level1」に変更しておきましょう。

Point of Entry を設置する

レベル 2 にはレベル 1 へ繋がる洞穴が 2 つ存在し、それぞれ入るとレベル 1 の別の場所に出るようにします。

f:id:Gigacee:20200702224801p:plain

レベル同士の移動を実現するためには、まず移動先のレベルに【Point of Entry】を設置する必要があります。レベル 1 の Point of Entry は、下端中央の扉と上端中央の扉の 2 つです。それぞれの位置に空の GameObject を作成し、「PointOfEntry0」「PointOfEntry1」とリネームしましょう*1。これらは重要な地点なので、分かりやすいようにラベルアイコンを設定しておくのをおすすめします。

f:id:Gigacee:20200702224822p:plain

設置ができたら、それらを Level Manager の「Points of Entry」に設定します。

f:id:Gigacee:20200702230718g:plain

このとき、順番が

PointOfEntry0
PointOfEntry1

になるよう注意してください。

Go To Level Entry Point を設置する

次に、移動元となる地点にそれぞれ空の GameObject を作成し、「GoToLevelEntryPoint0」「GoToLevelEntryPoint1」とリネームした後、GoToLevelEntryPoint と Box Collider 2D をアタッチします。これらにも、ラベルアイコンを設定しておくと良いでしょう。

f:id:Gigacee:20200702225657p:plain

コンポーネントの設定は、以下のようにしてください。

GoToLevelEntryPoint の「Activation Conditions」グループにある「Auto Activation」にチェックを入れる。
「Finish Level」グループにある「Level Name」に「sandbox_level1」と入力する。
「Points of Entry」グループにある「Use Entry Points」にチェックを入れる。
同じくの「Points of Entry」グループにある「Point Of Entry Index」に、それぞれ「0」「1」と入力する。
Box Collider 2D の「Is Trigger」にチェックを入れる。

これで設置完了です。シーンを再生し、レベルを移動できるかどうかを確認してください。

f:id:Gigacee:20200702224928g:plain

Point Of Entry Index

Level Manager の「Points of Entry」に設定された順番が、GoToLevelEntryPoint の「Point Of Entry Index」に対応しています。なので、順番に気をつける必要があったのですね。これは配列なので、名称を 0 オリジンにしたのもそれが理由です。

補遺

レベル 2 → 1 の移動を実装できたら、逆のレベル 1 → 2 の移動も同じように実装します。このとき、Point of Entry と Go To Level Entry Point が重なっていると、移動完了直後に勝手に移動処理が走ってしまうので、ある程度離しておきましょう。

f:id:Gigacee:20200703123322p:plain

NEXTTopDown Engine 入門 Part 10 ～初期位置編～

PREVTopDown Engine 入門 Part 8 ～シーン遷移編 1～

*1:「～1」「～2」じゃないの？　と思われるかもしれませんが、それは後ほど説明します。

2020-07-02

TopDown Engine 入門 Part 8 ～シーン遷移編 1～

Unity TopDown Engine

異なるシーン間を移動する

今まではずっと単一のシーンで制作してきましたが、タイトル画面や違うレベルの画面（フィールド←→ダンジョンなど）を制作する場合、別のシーンにすることが多いでしょう。今回は、こうしたシーン間の遷移を実装していきます。

というわけで、仮のタイトル画面を用意しました。タイトル画面で何かキーが押されたら、レベル画面へ遷移させます。

f:id:Gigacee:20200702130910p:plain

シーン名は以下のようにしておきます。

今まで作ってきたレベル画面：sandbox_level
タイトル画面：sandbox_title

また、Build Settings にこれらのシーンを追加しておくのを忘れないでください。

f:id:Gigacee:20200702130925p:plain

Loading Scene Manager

ここで、本講座で初めて、スクリプトが出てきます！　以下のようなスクリプトを書いてみましょう。

// SceneTransition.cs

using UnityEngine;

public class SceneTransition : MonoBehaviour
{
    void Update()
    {
        if (Input.anyKeyDown)
        {
            // ここでシーン遷移
        }
    }
}

そして、タイトル画面に空の GameObject を作成し、スクリプトをアタッチしてください。

スクリプト中のコメントにもあるように、Input.anyKeyDownが true になったらシーンを遷移させるようにします。Unity 標準のSceneManager.LoadSceneを使うこともできますが、ここでは TopDown Engine に備わっている機能を使ってみます。と言っても使い方は簡単で、以下の関数を実行するだけです。

MoreMountains.Tools.LoadingSceneManager.LoadScene("scene_name");

MoreMountains.Tools とは、More Mountains 製の Unity アセットで共通して使われている、様々な汎用的な機能のことです。シーン遷移はトップダウンビューのゲームに限らずあらゆるゲームで使われる機能なので、TopDownEngine ではなく MoreMountains.Tools にまとめられているのですね。

では、上記のスクリプトを SceneTransition.cs に追記しましょう。

// SceneTransition.cs

using MoreMountains.Tools;
using UnityEngine;

public class SceneTransition : MonoBehaviour
{
    void Update()
    {
        if (Input.anyKeyDown)
        {
            // ここでシーン遷移
            LoadingSceneManager.LoadScene("sandbox_level");
        }
    }
}

それができたら、タイトル画面のシーンを再生して、シーン遷移ができるかどうか確認してみてください。

f:id:Gigacee:20200702130942g:plain

Unity 標準の SceneManager と、More Mountains の LoadingSceneManager の違い

再生してみたら分かるとおり、特に何もしなくてもシーン遷移中にローディング画面が挿入されます。

f:id:Gigacee:20200702131001p:plain

Unity 標準の SceneManager を使う場合は自分でローディング画面を実装する必要がありましたが、LoadingSceneManager を使えばその必要も無いわけですね。

もちろん、ローディング画面をカスタマイズすることも可能です。ローディング画面のシーンは ThirdParty/MoreMountains/MMTools/Tools/SceneLoading/LoadingScreen.unity にありますので、ロゴをオリジナルのものにしたり、プログレスバーを好みのデザインに変えたりしても良いでしょう。

NEXTTopDown Engine 入門 Part 9 ～シーン遷移編 2～

PREVTopDown Engine 入門 Part 7 ～UI 編～

2020-07-02

TopDown Engine 入門 Part 7 ～UI 編～

Unity TopDown Engine uGUI

フェードイン・アウトを実装する

前回、テレポーターによるセクション間の移動を実装しました。しかし、画面の切り替わりが一瞬で行われるため、少々見栄えが悪いです。そこで今回は、セクション間の移動時に画面をフェードさせてみたいと思います。

Canvas と、UI 用のカメラを追加する

フェードのグラフィックは uGUI で実装します。Hierarchy ウィンドウ左上のプラスボタンを押し、UI > Canvas と選択します（このとき、EventSystem が同時に追加されます）。

Canvas を映すカメラも用意します。空の GameObject を作成して「UiCamera」とリネームし、Add Component から Camera を追加してください*1。UiCamera の位置はどこでも構いませんが、レベルと重なっていると見づらいですので、遠いところに移動させると良いでしょう。

また、Main Camera にアタッチされている Input Manager を、UiCamera に移動させておきましょう。こうしておけば、もし UI しか存在しないシーン（タイトル画面など）があったとしても、UiCamera さえあれば Input Manager を別に用意する必要が無くなります（UiCamera を Prefab にしておきましょう）。

ここで、Canvas のレイヤーが「UI」になっていることを確認してください。確認ができたら、Camera の「Culling Mask」が「UI」のみになるよう設定します。こうすることで、UiCamera が Canvas のみを映すようになります。その他の設定は、作っているゲームに合わせて適宜変更してください。ここでは一例を紹介します。

f:id:Gigacee:20200702003045p:plain — Canvas の設定

f:id:Gigacee:20200702003149p:plain — UiCamera の設定

フェーダーを追加

Canvas の子として空の GameObject を作成し、「Fader」とリネームします。そして、Add Component を More Mountains > Tools > GUI と進み、「MMFader」を選択します*2。すると、Canvas Group と Image、MMFader がアタッチされます。これが、フェードに用いるグラフィックになります。RectTransform を縦横ともに Streach にして画面全体を覆うようにし、Image の「Color」を黒色に、Canvas Groupの「Alpha」を「0」に設定しましょう。

トランスポーターのフェードを有効にする

前回作成した TeleporterToLevel2、TeleporterToLevel1 にアタッチされている Teleporter コンポーネントに、「Trigger Fade」という設定項目がありますので、これにチェックを入れます。これで、フェードが実行されるようになりました。

f:id:Gigacee:20200702003130p:plain

動作確認

最後にシーンを再生し、セクション間を移動する時に画面がフェードすることを確認しましょう。

f:id:Gigacee:20200702003024g:plain

補遺

Teleporter コンポーネントの「Trigger Fade」の下に「Fader ID」という項目があり、デフォルトでは「0」が設定されています。これはその名の通りフェーダーの ID 番号で、MMFader の ID に対応しています。

f:id:Gigacee:20200702003103p:plain

両者の番号を異なるものにすると、フェードが実行されなくなることが確認できます。

NEXTTopDown Engine 入門 Part 8 ～シーン遷移編 1～

PREVTopDown Engine 入門 Part 6 ～テレポーター編～

*1:Hierarchy ウィンドウのプラスボタンや右クリックから直接 Camera を追加しても良いのですが、その場合 Audio Listener がアタッチされた状態で追加されるので、忘れずに削除しておきましょう。

*2:「More Mountains」とは、TopDown Engine の開発元のことです。More Mountains は TopDown Engine の他にもいろいろなアセットを開発しており、それらに共通して使われているツールが More Mountains > Tools に入っています。

2020-07-01

TopDown Engine 入門 Part 6 ～テレポーター編～

Unity TopDown Engine

異なるセクション間を移動できるようにするには

レベルの中に扉や階段を配置して、別のセクションへ移動できるようにしたいという場合も多いでしょう。今回は、TopDown Engine にある【テレポーター】という機能を使い、セクション間の移動を実装していきます。

というわけで、移動先となるセクション 2 を用意しました。セクション 1 とはドアを介して移動できるようにします。また、カメラがセクション 2 も撮影できるように、LevelManager にアタッチされている Box Collider の「Size」を広げておきます。

f:id:Gigacee:20200702122646p:plain

テレポーターを設置

まず、セクション 1 → 2 へ移動するためのテレポーターを設置します。以下の手順に従ってください。

空の GameObject を作成し、「TeleporterToSection2」とリネームする。
テレポーターを設置したい場所（この場合はドアの前）に移動させる。
Box Collider 2D と Teleporter*1 をアタッチする。*2

f:id:Gigacee:20200702122739p:plain

Box Collider 2D の「Is Trigger」にチェックを入れる。
Box Collider 2D の「Size」を調整する。
Teleporter の「Auto Activation」にチェックを入れる。

f:id:Gigacee:20200701215831p:plain

ここまで完了したら、セクション 2 → 1 へ移動するためのテレポーターも用意しましょう。TeleporterToSection2 を複製して「TeleporterToSection1」とリネームし、セクション 2 のドアの前に移動させます。

テレポーターの移動先を設定

テレポーターの設置が完了したら、今度は相互に移動できるよう移動先を設定します。

TeleporterToSection2 の Teleporter コンポーネント内にある「Destination」に、TeleporterToSection1 を設定する。

f:id:Gigacee:20200702122753g:plain

同様にして、TeleporterToSection1 の「Destination」に TeleporterToSection2 を設定する。

これで、セクション間を移動できるようになりました！　シーンを再生して、テレポーターでセクションを移動できるかどうか確かめてみましょう。

f:id:Gigacee:20200701215413g:plain

NEXTTopDown Engine 入門 Part 7 ～UI 編～

PREVTopDown Engine 入門 Part 5 ～カメラ編～

*1:このコンポーネントだけ、「TopDown Engine」の中ではなく「Corgi Engine > Enviromnent」にあります（Ver. 1.8 時点）。おそらくエンジン側のミスで、作者さんには連絡しておいたので、じきに修正されるかと思います。

*2:Sprite Renderer や Particle System をアタッチし、扉や階段の画像、ワープホールのエフェクトなどを設定することもできます。

2020-07-01

Cinemachine にコンファイナを設定してカメラの動きを制限する

Unity Cinemachine

TopDown Engine 入門 Part.5 ～カメラ編～にて、TopDown Engine 用のコンファイナのセッティングをしましたが、TopDown Engine の機能を使わず Cinemachine の標準機能だけで設定する方法も紹介します。

カメラを 2D 用の設定に変更

「Main Camera」を選択し、Camera コンポーネントの「Projection」を「Orthographic」に変更する。

コンファイナとなる GameObject を作成

空の GameObject を作成し、「Confiner」とリネームする。
Composite Collider 2D をアタッチする。
1. このとき、同時に自動で RigidBody 2D がアタッチされます。
Composite Collider 2D の「Is Trigger」にチェックを入れる。
Composite Collider 2D の「Geometry Type」を「Polygons」に設定する。
Rigidbody 2D の「Body Type」を「Static」に設定する。
Add Component から Box Collider 2D をアタッチする。
Box Collider 2D の「Used by Composite」にチェックを入れる。
Box Collider 2D の「Size」をステージに合うように調整する。

Virtual Camera にコンファイナを設定

CM vcam1 にアタッチされた CinemachineVirtualCamera の一番下にある「Add Extension」から「CinemachineConfiner」を選択する。「Cinemachine Confiner」がアタッチされる。
「Bounding Shape 2D」に、先程作成した Confiner を設定する。

2020-07-01

TopDown Engine 入門 Part 5 ～カメラ編～

Unity TopDown Engine Cinemachine

カメラの作り方は自由

このままだとキャラクターが移動しても画面が動かないので、キャラクターの動きに合わせてカメラも動くようにしてみましょう。と言っても、カメラに関しては TopDown Engine 特有の決まりはありません。単純にキャラクターに追随させるだけなら、Main Camera を Player の子にしてしまえば OK です。

より高機能なカメラを実装したい場合は、Unity 公式のパッケージである「Cinemachine」を使います。最初に TopDown Engine をインストールしたときに、Cinemachine も自動でインポートされていますので、使い始めるのに追加の操作は必要ありません。早速使ってみましょう。

Cinemachine 入門

Virtual Camera と Brain

メニューバーに「Cinemachine」という項目があるので、その中にある「Create 2D Camera」をクリックします。

f:id:Gigacee:20200701024024p:plain

すると、「CM vcam1」という GameObject が作られるとともに、Main Camera に「CinemachineBrain」というコンポーネントがアタッチされます。CM vcam1 には「CinemachineVirtualCamera」というコンポーネントがアタッチされていて、この CinemachineVirtualCamera が CinemachineBrain を制御するという関係になります。

Follow の設定

CinemachineVirtualCamera の「Follow」にオブジェクトを設定することで、そのオブジェクトをカメラが追うようになります。

f:id:Gigacee:20200701024019p:plain

なので、ここに Player を設定すれば良いわけですが、前回の補遺にもあるように、実際には Player が Hierarchy に居ない場合も多いでしょう。ですが心配はいりません。TopDown Engine は、その点もカバーしています。

CM vcam1 に、「Cinemachine Camera Controller」というスクリプトをアタッチしましょう。「Add Component」ボタンを押して、検索ボックスにワードを打ち込んで見つけてください。*1

f:id:Gigacee:20200701024012p:plain

完了したら、シーンを再生し、キャラクターを動かしてみてください。カメラがキャラクターを追うようになりましたか？

f:id:Gigacee:20200701024052g:plain

Cinemachine Camera Controller は何をしているのか

次に進む前に、Cinemachine Camera Controller が実際には何をしているのかを解説します。

先程、CinemachineVirtualCamera の Follow に設定された対象をカメラが追うと説明しましたが、シーン再生中にこの項目を見てみると、「CameraTarget」というオブジェクトが自動で設定されることが分かるでしょう。そしてその CameraTarget は、Player の子の GameObject です。

f:id:Gigacee:20200701024107p:plain