Rider for Unreal Engine(EAP版)でRiderLinkプラグインを使う

Rider for Unreal Engine(EAP版)でRiderLinkプラグインがどういうものか、いまいちピンとこなかったので色々と試してみました。

書くこと

RiderLinkプラグインの使い方

書かないこと

UE4およびRider for Unreal Engineのインストール
Rider for Unreal Engine(EAP版)とUE4の連携
プラグインビルドのやり方及び取得

前回書いた記事、Rider for Unreal EngineとUnreal Engine4.24を連携させる（EAP版）である程度は書いたので、興味があれば見てください。

試した環境

以下の環境で試しています。

・Rider for Unreal Engine 2020.1.1(EAP版)
・UnrealEngine 4.24

OS:Windows 10 Home
GPU:NVIDIA® GeForce RTX™ 2080 Max-Q デザイン 8GB GDDR6
CPU:インテル® Core™ i7-9750H（2.6GHz / Turbo 4.5GHz / 6コア12スレッド）
メモリ:16GB（8GB ×2）DDR4

RiderLinkプラグインの使い方

前回書いた記事、Rider for Unreal EngineとUnreal Engine4.24を連携させる（EAP版）の「UE4プラグインビルド」でUE4側のプラグインソースがあるので、これを見てプラグインをビルドしてください。

そのため、この記事ではプラグインビルドのやり方は省略します。

※Rider for Unreal Engine側のUnrealLinkプラグインはデフォルトで有効になっています。

プラグインを有効化した場合

・プレイモードがRiderのエディター側（画像の赤枠部分）も使えるようになる

Rider側で開いているレベルのデバッグプレイができるようになります。

通常はRider起動時にUE4側のエディターが起動されていれば自動的に有効化されます。
しかし、時々リンクに失敗して無効化される場合があるので、その時はビルド（金槌みたいなマーク）ボタンを押してエラーなく終われば有効化される時があるようです。

それでも完全にリンクが切れてしまった場合は、Rider経由でプロジェクトを起動する必要があるので、一度プロジェクトを閉じてから、右端にある再生ボタン（Run〇〇とツールが表示される部分）かデバッグボタン（虫マーク）を押してください。

→完全にリンクが切れた場合は画像の通り、ストップボタンが無効化（灰色っぽい四角）されています。

以下の画像の通りにボタンが変化し、ストップボタン（赤い四角）が有効化されていればOKです。

・エディターログがRider側（画像の赤枠部分）に表示されるようになる。

エディターログ（UE4側ではアウトプットログで表示されるログ）がRiderで表示されるようになります。

プラグイン無効化した場合

・ビルドしてもプレイモード関連（画像の赤枠部分）の部分が無効化されている

・エディターログがRider側（画像の赤枠部分）表示されない

メリット

プラグインを軽く触った結果、いくつかのメリット、デメリットが判明しました。
まずはプラグインを使うメリット側から。

エディター側でプレイモードの起動、設定ができるようになる

RiderLinkプラグインを使うことで、ビルド後にUE4エディターに戻ってプレイモード起動、という一手間がなくなります。

Riderでソースを修正した場合、ビルド後、再生ボタン（Start Unrealとツールが出るボタン）を押すだけで選択したプレイモードでデバッグプレイができるようになります。

プレイモードの設定もRiderで出来ます。歯車のマークをクリックすると設定項目が表示されます。

・プレイヤー数の設定

・プレイヤーのスポーン位置

・プレイモードの選択

・Dedicated Serverを使用するか否か

スタンドアローン、VRプレビュー等、アウトプットログが表示されない、もしくは消えてしまうデバッグプレイで、Rider側でログが常に表示されるようになる。

地味ですが、これが非常に大きなメリットと感じています。
通常ではスタンドアローン、VRプレビューはアウトプットログが使用できませんが、RiderLinkプラグインを使うことで、Rider側で常にアウトプットログを拾うことができるようになります。

・スタンドアローンでUE4側のアウトプットログとRider側のUnrealEditerLog（下の部分）の表示の違い

特にVR開発ではデバッグプレイではアウトプットログが消えてしまうので、ログ表示に工夫が必要でしたが、RiderLinkプラグインを使うことで簡単にログを表示することが可能になりました。
便利！

デメリット

当然ですが、デメリットもあります。

EAP版はベータ版である

まだベータ版であるため、予期せぬ不具合がある可能性が高いです。

→現状では「ビルドするたびにUnreal Editor Logが増えていく場合がある、そしてそれを消す手段がない」等

ビルド時間が長くなる

また、エディターのログを共有している都合か、ビルドの時間が若干長いです。

・RiderLinkプラグインを無効化している時のビルド時間

・有効化している時のビルド時間

→プラグイン有効時に限りワーニングも出ているので、そのせいもあるかもです

不安定な点を除けば、Rider for Unreal Engineを使う上でRiderLinkプラグインを使わない理由が上記以外見つかりませんでした。

まとめ

RiderLinkプラグインはRiderでUnrealEngineを用いた開発をする場合、とても便利なプラグインです。
かゆいところに絶妙に手が届く機能なので、もし使う機会があればぜひ使いましょう。