Unreal Engine 4.24 で文字（テキスト）を２D画面に表示する

ボスを倒したときとかに、3Dの画面の手前に「勝利！」みたいな文字が流れるやつの作り方です。いわゆる、ウィジットというものを使います。

# 準備

- Windows 10 home/pro
- Unreal Engine 4.24

# 方針

- サードパーソンテンプレートを使う（他のテンプレートでも同じようなことはできる）
- ボックストリガーを配置して、そこにプレイヤーが入ったら文字が表示されるようにする。
- ボックストリガーから出たら文字は消える。

# 手順

## サードパーソンテンプレートでプロジェクトを作る。

作り方は[Unreal Engine 4.24 で正確に往復移動するオブジェクト（アクター）を作る](https://qiita.com/mml/items/be3f0b6c29b477bcc93a)の記事に書いたので、ここでは省略。プロジェクトを作成したところからメモ開始。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/bafce386-45ae-513b-0e9e-f235cdff4c79.png)

## テキスト表示部（ウィジット）を作る

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/96cc9ad3-8b48-6099-2017-b69ba8aa5b04.png" width="60%"/>

コンテンツブラウザで右クリックして、ユーザインタフェースからウィジットブループリントを選ぶ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/51d0331e-1713-0a3c-19c7-60cd7f5d4fc4.png)

NewWidgetBlueprint という項目ができるはず。名前は変更できるけど、ここではこのままの名前で進める。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/1e9882ba-0e18-da30-08b2-d5322befcd55.png)

NewWidgetBlueprint をダブルクリックすると、ウィジット（２D画面）の編集ウィンドウが開く。もしイベントグラフが表示されていたら、右上の「デザイナー」のボタンを押すとこの画面になるはず。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/32d5c472-0a0b-c9ec-ee15-23f0946222e2.png" width="60%"/>

左側の「パレット」の中から「一般」「Text」を選んで、中央の画面の中までドラッグドロップする。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/51711472-bc9f-7db5-d72c-56a22422b7c1.png)

すると、緑色の枠がついた文字が表示されるので、右側にある「詳細」の中のパラメータを変更して、文字の内容とか、色、フォントサイズ、位置などを変更していく。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/9438dbc8-3029-a322-5119-6f40d8b98540.png" width="60%"/>

特段の理由がなければ、Size To Fit にチェックを入れておくことと、アンカーのプルダウンメニューで真ん中に四角のあるもの（下図）を選んでおくといいかも。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b6db808e-0075-127b-421f-ddb944009a05.png)

編集が終わったら、左上にある「コンパイル」を押して、ブループリントを編集するウィンドウをいったん閉じ、メインウィンドウに戻る。

## プレイヤーが入ったら反応するボックストリガーを置く

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/bb01eecc-ea5f-5ad9-b616-a50ff66ef82b.png)

左側の「基本」を押して、ボックストリガーを探してメイン画面の中にドラッグドロップで置く。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/0b44b1af-6649-aa1b-587f-3234c36152c9.png)

右側のアウトライナの中から、今置いた TriggerBox を探して、トランスフォームの「拡大縮小」を調整して、ボックストリガーを少し大きくしておく。ここでは X と Y の拡大率を 3 くらいにしてみた。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/06256125-0a66-25be-4b8b-036f058eb7f6.png)

TriggerBox を選んだ状態で、ブループリント/スクリプトを作成を押す。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/67cbf456-785c-e924-23d9-7f6869f693c1.png" width="60%"/>

このウィンドウが出たら、そのまま「ブループリントを作成」を押す。Blueprint の名前は、デフォルトで TriggerBox_Blueprint になるはず。

ボックストリガーの設定はここまで。

## ボックストリガーに入ったら文字を表示するブループリントを書く

ブループリントを書く場所は、ウィジット側に書く方法と、ボックストリガー側に書く方法、レベルブループリントに書く方法がある（と思う）。複数のアクターというかブループリントをまたいだ処理になるので、ここではレベルブループリントに書いてみる。

### 準備

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/f39b818b-a3a2-ed96-454f-3e5d8a7fb042.png" width="60%"/>

メインウィンドウの上にある「ブループリント」のメニューから「レベルブループリントを開く」を選ぶ、

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/43d96c22-2a47-77c8-7d55-80860a4a22e3.png)

こんな画面になるはず。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/54c481ac-3ed6-3c23-5b60-42fc9a38bd7f.png)


左側の「マイブループリント」の中にある「変数」の右の＋を押して変数を作る。ここでは HairunoKanshi という名前にしといた（わざと日本語っぽくしてるのは、名前は自由につけていいということを示している）、

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/aa963499-bd7e-1b4d-a4e8-fcbac75ac846.png)


HairunoKanshi 変数を選択した状態で、詳細のところで「変数の型」のプルダウンメニューを開いて、TriggerBox と入力する、すると TriggerBox_Blueprint という項目が出てくるのでそれを選ぶ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/065709a0-afc5-617b-fee2-23d3757a330d.png)

選んだら、変数の型の色が青っぽくなるはず。「変数の型」のすぐ下にある「インスタンス編集可能」という項目にチェックを入れておく。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b6db808e-0075-127b-421f-ddb944009a05.png)

これで一度、左上の「コンパイル」を押しておく。

### ウィジットを表示するイベントグラフを書く

ゲーム開始時に、ウィジットの作成だけしておいて、表示の必要があったときだけ Viewport （つまり画面）に出して、不要になったら画面から消す、みたいな感じで処理を書いてみる。

### ウィジットの初期化の処理部分

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/70017d3a-f444-1471-22d1-8306bd92c266.png)

BeginPlay イベントを置く。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b14fd1df-d5de-9aae-b34b-f983fa2f5213.png)

ウィジットを作成のノード置く。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/e4ee8268-3449-e76b-620a-9ce75e1bc238.png)

クラス名は New Widget Blueprint を選んでおく。

 ![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/cdf6bca9-0361-8db3-44e2-bd33acced5c0.png)

Return Value の先を伸ばして右クリックして「変数へ昇格」を選ぶ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/04eae092-269f-fedb-693d-eafab8d599c3.png)

こんな感じになるので「セット」のところの NewVar0 という名前を、HyoujiMoji とかに変えておく。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/133f1320-9cb5-c6db-e553-0f0420690230.png)

これで、ゲームの開始時にウィジットが作成される。でも画面には表示されない。

### ボックストリガーに入ったらウィジットを表示する

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/4627e1c2-5dfe-2903-68d4-3e4eb1cce9da.png)

HairunoKanshi を選ぶと「詳細」の下のほうに「イベント」という項目ができていて、その中に On Actor Begin Overlap という項目があるので、右側の緑色の矩形に＋と書いてあるボタンを押す。すると、イベントグラフの中に赤いノードが追加される（はず）。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/f6ac15cc-9517-35ce-be93-13f88c05b3cb.png)

「変数」の HyoujiMoji をイベントグラフにドラッグドロップすると Get か Set が選べるので、Get を選ぶ。そのあと、置かれたノードから線を伸ばして右クリックして、AddTo とか入力すると、AddToViewPort というのが選べるのでそれを選ぶ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/7e6b2781-b79f-98d5-394a-2c587719cde1.png)

こんな感じでグラフをつなぐ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b6db808e-0075-127b-421f-ddb944009a05.png)

これで「コンパイル」を一度押しておく。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b73c4d72-23c9-485f-9648-aace0d7ae886.png)

変数の HairunoKanshi を選んだ状態で、右の「詳細」を見ると、真ん中あたりにデフォルト値という項目ができているので、そのプルダウンメニューを開いて TriggerBox_Brueprint を選ぶ。

もういちどコンパイルしてメインウィンドウにもどる。

## 実行

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/a00cdb63-8205-ae6f-d0c6-913e8e847dd7.png)

これで、ボックストリガーのある位置にプレイヤーが入ったら、画面に Haittade! と表示されるようになる。

## 課題

しかし、今の状態だといくつか問題がある。

- 一度表示されたら消えない。
- ボックストリガーに出入りすると、screen にすでに追加されてるで！みたいなワーニングが出る。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/9b1aebac-01f6-9ffe-0ae9-39a318bbb489.png)

ワーニングというのはこんなやつ。The widget 'NewWidgetBlueprint_C' was already added to the screen. とか表示される。これは、すでにウィジットが Viewport に追加済みの状態になっているのに、オーバーラップのイベントが起こるたびに Viewport に再度追加しようとするために表示されている。

# 消えるように改造

ボックストリガーから出たら Viewport から削除するようにする。そうすれば、表示されっぱなしということはなくなるし、ボックストリガーに再度入るときは、必ず Viewport から削除されている（外に出ている状態でなかければ、再度入ることはできない）はずなので、ワーニングも出なくなる（多分）。

## レベルブループリントの改造

メインウィンドウの「ブループリント」のメニューから「レベルブループリントを開く」を選んで、レベルブループリントを編集できる状態にしておく。
、
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/d92410e8-6699-89ab-1108-b0fe10d130f5.png)

変数の HairunoKanshi を選んで、右側の「詳細」の「イベント」の中にある OnActorEndOverlap の緑色のボタンを押す。すると、上のように ActorEndOverlap の赤いノードが追加されるはず。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/4a0b2382-8058-3d07-bbf4-0e77bc32fcb1.png)


「変数」の HyoujiMoji をイベントグラフに置く（メニューはGetを選ぶ）。HyoujiMoji の青いノードからラインを伸ばして、**右クリックしてから「状況に合わせた表示」のチェックを外して**、検索欄に RemoveFrom と入力する。すると Remove from Parent が選べるので、それを選ぶ。チェックを外さないと、この選択肢が表示されないことがある。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/55031e5f-6e37-5ad9-4b56-e184ffd63a99.png)

こんな感じでグラフを作る。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b6db808e-0075-127b-421f-ddb944009a05.png)

コンパイルする。これで、ボックストリガーの外に出ると文字が消えるようになる（はず）。

## 実行

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/a2210272-96f1-9a3a-17ae-5602e33fe537.png)

ちゃんと消えたね！（静止画じゃわかんないけど…）ワーニングもでないはず。

Delay を使って、一定時間たったら消えるようにするのもありだけど、その場合は文字が消える前にボックストリガーから出て、すぐにまた入るとワーニングがでてしまう。その場合は、AddToViewPort する前に、HyoujiMoji に Parent があるかどうかを判定するなどして、二重に追加しないようにチェックすることで回避できる（多分）。

# 文字をアニメーションさせる（おまけ）

ウィジットの文字にアニメーションを追加することで、表示されたときに文字を動かしたり、色を変えたり、変形させたりとか、動きをつけることができる。おまけ的に、作り方を簡単にメモっておく。

## 準備

ここでは、Haittade!! という文字が 3 秒かけて左から右に移動するというアニメーションを作ってみる。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/5344d48f-41c4-45e5-a2fe-181d8ea8c3ca.png)

コンテンツブラウザで NewWidgetBlueprint を選んでダブルクリックする。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/51711472-bc9f-7db5-d72c-56a22422b7c1.png)

右上の「デザイナー」のボタンを押して、この画面にしておく。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/70b67321-6906-dce2-96df-8e09951b6878.png)

左下にある「アニメーション」というボタンを押す。名前を入力できるけど、とりあえずこのままでやる。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/2d4519bf-d7b8-7a42-b783-a1d7efc244ae.png)

アニメーションを追加してから中央下あたりにあるライムラインというタブを押すと、こんな感じの表示になるはず。

## アニメーションの編集

ここからアニメーションの編集をする。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/72159e05-94fb-834e-bcac-866b127258db.png)

下のトラックのところの時間を 0 のところに合わせた状態にして、ウィンドウの中にある Haittade!! という文字を左側の画面外の位置に移動させる。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/223253c9-aee1-d560-8173-fec938a0b6a1.png)

位置が決まったら、右側の「詳細」の中の 位置X という項目の右側にある小さいポチを押す。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/e2c5f3d6-1dcd-68da-c960-88a578ffb132.png)

すると、こんな感じでタイムラインの0秒のところにキーフレームが設定されるはず。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/3e3f4891-388e-d191-bd73-88c2cf6c5faa.png)

次に、**タイムラインのところの時刻を表す縦線を 3 秒のところに先に移動してから**、画面内の文字を右の画面外の位置まで動かす。ちなみに Y 座標をかえずにマウスで移動したければ、Shift キーを押しながら移動すると、水平に移動できる。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/a6574fa8-7fde-02aa-719f-5a84a039737f.png)

再度「位置X」の横のポチを押す。これで3秒のところにもキーフレームが設定される。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b1230493-0190-82b7-e2a7-d16886abb3e4.png)

これでアニメーションの編集は終わったので、一度コンパイルしておく。

## アニメーションを実行する

アニメーションは作っただけでは実行されず、プログラムで明示的に「アニメーションを実行しろ！」と命令しないといけない。アニメーションを実行するには、直前の手順で作った NewAnimation という変数（アニメーションは変数扱いになる）を参照する必要があるので、たぶんアニメーションを作成した NewWidgetBlueprint の中で実行するのが素直な気はする。

でも、ここではあえて NewAnimation をレベルブループリントから再生してみる。そうしたほうが、コードが一か所にまとまってすっきりするし（適当）。

## アニメーションを外部から実行できるようにする

メインウィンドウの「ブループリント」のメニューから「レベルブループリントを開く」でレベルブループリントを編集できるようにする。ここまで編集した内容に以下を加える。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/8cd57a6d-aaaa-c1e3-03d0-34d579ca1974.png)

イベントグラフ内にある Hyouji Moji から線を伸ばしてメニューを出し、PlayAnimation と入力する。するといくつか選択肢が出るので、Play Animation With Finish Event の項目を選んでつなぐ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/e2e884f4-5460-7b12-d4e4-3cd7e134ac43.png)

再度、Hyoji Moji から線を出して、GetNew と入力する。すると Get New Animation が出てくるので、それを選ぶ。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/5053c723-5070-f523-8b07-fd5be97dd0d5.png)

最終的にこんな感じにつなぐ。これで、アニメーションが実行されるようになる。

## 実行

コンパイルしてから実行する。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/266247/b3e7186b-bfca-4c57-cbac-eec9243f2392.png)

ここまでの手順が間違っていなければ、こんな感じで動くはず。（静止画だけど）

ボックストリガーの範囲外に出ると、アニメーションは止まって文字も消える。再度ボックストリガーに入れば、アニメーションは実行される。

Play Animation With Finish Event 以外の、たとえば Play Animation Forward とかでもアニメーションは再生されるのだけど、これだと画面から文字が消えてもアニメーションが終了したことにはならないようで、すぐにボックストリガーに入りなおすとアニメーションが表示されない。

Play Animation 関係のノードは、動作が微妙に違うようなので、使うときは調べてみてね！

# 参考

- [アニメーション(公式)](https://docs.unrealengine.com/ja/Engine/UMG/UserGuide/Animation/index.html)