Unity3d用のビジュアルロジックエディター。 パート1

はじめに

読者の皆さん、こんにちは。今日の記事では、 Unity3dでのアプリケーション開発における、視覚的開発、より正確にはコードとロジックの視覚的表現を使用した開発などの現象について説明します。 そして、続行する前に、すぐに明確にしたいのですが、「絶対に」という言葉から、ビジュアルプログラミングについては話していません。Unityの世界でのブループリントのバリエーションやC＃コードの生成はありません。 では、ビジュアルロジックエディターとはどういう意味ですか？ この質問への答えに興味があれば、猫の下で歓迎します。

ビジュアルロジックエディターとは

開発中、プログラマは常に、システムのものからゲームの仕組みまで、さまざまなことを行うさまざまなコードをたくさん書くと主張する人もいます。 プログラマが「本物」である場合、このコードは通常、再利用できるように統合および分離されます（Unity内では、このコードはコンポーネントであり、 MonoBehaviorの継承者でもあります ）。 特にこれが最初のプロジェクトでない場合、そのようなコードがたくさんあることを想像することは難しくありません。 今、私たちが新しいプロジェクトを始めており、多くの高速で異なるプロトタイプを作成する必要があり、プログラマーのチームは限られており、誰もがメインプロジェクトで忙しいと想像してみましょう。 ゲームデザイナーはinしているので、テスト、チェック、プロデューサーがマネージャーを駆け回ってプログラマーを引き出そうとしている、お金が限られている、時間が足りない、などが必要です。



コインの反対側である私たち（プログラマー）は、コンポーネントの形で多くのコードを作成しました。それらはシーン内のさまざまなオブジェクトの大きなリストにハングアップします。 そして、私たちはチームを拡大し、新しいプログラマーを採用し、彼はそれを整理するためにステージを開き、誰が誰を、どの順序で、どのコンポーネントをどの方法で、どのように接続するのかなど、さまざまな質問にinれます。ドキュメンテーションはありますか？」（ドキュメンテーションはありますが、事実ではありませんが）ここでのポイントは、新しい人がチームに参加するためのしきい値が可能な限り低く、このプロセスの時間を可能な限り短くすることです。



上記の状況を解決する方法は？ 記事のタイトルの答えはVisual Logic Editorです。 これは何？ これは、ロジックのさまざまなコンポーネントを視覚的に操作し、それらの関係（「ソフト」バージョン）を構成し、シーンのオブジェクトをシーンから間接的に操作できる環境です。 それを途方もなくシンプルな形で説明すると、幼少期にキューブから異なるデザインを組み立てるようなものです（この場合のみ、キューブはしっかりと接続されておらず、底面が取り除かれ、デザインは落ちません）。



それで、私たちは定義を理解しましたが、これは最終的に私たちに何を与えますか？

• プロジェクトで再利用できるユニバーサルデザインを収集できるため、その後のルーチンを削減できます。 私たちのプロジェクトである一種の純粋なフィールドを想像してください。別のゲームから組み立てられた構造を取り出し、それをフィールドに置くだけです。
• 分離された「キューブ」（機械、ロジック、機能）のデータベースを作成できます。このデータベースから、プログラマーではない人が自分で構造を組み立てることができます。
• デザインをオンザフライで他のデザインに置き換えて、ロジックの動作を変更することができます。
• 構築物を遅延モードで使用できます。たとえば、現在NPCが世界に存在しない場合、それに関連付けられたロジックは「フィールド」に存在しません。
• キューブはリジッドリレーションシップによって接続されていないため、必要に応じてキューブをオフおよびオンにして、任意の複雑な条件付きおよび無条件分岐を実装できます。

まあ、それはかなり良い音ですか？ しかし、実際には何ですか？ Asset Storeを開いてVisual Scriptingセクションを見ると、原則として多数の異なるプラグインを見ることができます。 それらのほとんどは、Unreal Engineのブループリントテーマのバリエーションです。つまり、本質的にはコード生成です。 ビジュアルロジックエディターの概念に適合するシステムは、実際にはありません。 最も近い意味は次のとおりです。

1. プレイメーカー はい、FSMプラグインですが、それでも、独自のアクションを作成できます。 インターフェイスの観点からはそれほど便利ではありませんが、特定の点では非常に優れています。 ブリザードは、ハースストーンで使用された無駄ではありませんでした。
2. Behavior Designer / MoonBehaviorなど 状態ツリープラグイン。 上記に近いものですが、多くの制限があります。結局のところ、状態ツリーはコンポーネントに関する本格的なロジックではありません。
3. ICode これはプレイメーカーの類似物であり、実際にはステートマシンでもあります。

親愛なる読者の皆さんにお願いする方法はありますか？ 1つだけを見つけて、システムを作成しましたが、それを実行しましたが、そのパスは非常に長く厄介でした。

方法

Unity3Dのビジュアルロジックエディター用のプラグインを開発するというアイデアは、かなり前に生まれました。 最初は、もしそうなら、それはクールだと思っていました。 これらの考えは、多くの同様のゲームがあり、非常に迅速に行う必要のある20を超える作品があるプロジェクトに取り組む過程で現れました。 最初の実装はインターフェースの点でひどいものでしたが、もちろん、それによって特定の速度でゲーム全体を正常に開発することができました。



次のプロジェクトでは、本格的なビジュアルエディタを作成することが決定されましたが、その結果、経験が少なかったため、実装は成功せず、すべてが非常に遅く、接続数などがスケールから外れたため、何をどこで把握することは不可能でした（参照スクリーンショットと怖がらないでください）。







その後、アイデアはしばらく延期されました。 以下のプロジェクトは、純粋なコードで既に行ったものですが、そのアイデアはまだ頭に浮かびました。 徐々に、過去の過ちを考慮に入れて、最終的な（私には思えた）ビジョンと要件のリストが作成されました。 そして、2017年に、次のフリーランスプロジェクトが完了した後、このプラグインに6〜7か月を費やして、 Asset Storeに置くことを試みる余裕があると判断しました（今でもあり、 Panthea VSと呼ばれます ）。 このような複雑なプロジェクトでの作業経験の観点から見ると、それはすべて非常にクールでした。 2017年11月でしたが、やる気を少し失い、離婚し、街を変え、人生を完全に変えました。そして、サモエディズムに陥らないようにするために、ビジュアルロジックエディターのトピックについて別の角度から見ることにしました。 結果はuViLEdで 、無料で投稿することにしました。 私はフルタイムの契約に署名したので、週末と祝日に仕事をしなければならず、2018年から2019年の初めまですべてかかりました。 uViLEdは、Roslynコンパイラ（C＃7+）のコードの完全なリファクタリングであるPanthea VSの大きな再考であるため、すべてがUnity3d 2018.3バージョンからのみ機能します。



注 ： パンテアVSは、いくつかのプロジェクト（特にAndroidとiOS、特にLevのトラックと車）を立ち上げました。原則として、それを使用した体験は成功しましたが、エディターを書くことと、正しく使用する方法を学ぶことが別のことです）

uViLEdとその使用方法

はじめに

したがって、最終的に何が起こったのか、最初に写真を見て、次に続行します（さらに写真があります）。







に基づいたビジュアルロジックエディターは何ですか？







ここに：

• コンポーネント -これは、いずれかの機能、実際にはMonoBehaviourの類似物を実装するコードであり、この場合のみ、すべてのコンポーネントがLogicComponentクラスから継承されます。LogicComponentクラスはScriptableObjectです。
• 変数は、データ（カスタム構造やクラス、シーンオブジェクトへの参照、プレハブ、アセットなど）を保存できる特別なScriptableObjectです。 コンポーネント間でデータを共有する必要がある場合、つまり、各コンポーネントが目的のタイプの変数を参照でき、それが1つである場合、変数が必要です。
• 接続は、互いのメソッドを呼び出すコンポーネント、方法、順序を視覚的に表現した説明です。 コンポーネント間の関係は、タイプINPUT_POINTおよびOUTPUT_POINTの 2つの専用フィールドを使用して決定されます。 リンクは常に、コンポーネントの出力ポイントから別のコンポーネントの入力ポイントへと形成されます。 これらの接続は厳密ではありません。つまり、プログラマには見えず、コードにも含まれていません。 これらはエディターにのみ存在し、シーンが開始されると、ロジックコントローラー自体がコードを認識します。 これがどのように起こるかについては、別の記事で説明します。

コンパートメント内のすべてのもの（コンポーネント、変数、関係）がロジックを形成します。 一般的に、それほど複雑なことはありません。プログラマーはコンポーネントと変数のコードを記述し、ゲームデザイナーまたは別の（またはおそらく同じ）プログラマー/スクリプターがこれらのコンポーネントをエディターに配置し、接続とパラメーターを調整することでロジックを形成します。

uViLEdの主な機能

• 外部ソース（ハードドライブまたはサーバー）からの起動を含む、遅延モードでのロジック（コンポーネント、変数、および関係のセット）の実行
• コンポーネント間の接続の構成（呼び出し順序、アクティブ化および非アクティブ化）
• MonoBehaviorの子孫を含むコンポーネントと他のコードの簡単な統合
• エディターでのコンポーネントの外観のオーバーライド（CustomPropertyDrawerに類似）
• Unity3dインスペクターを使用したコンポーネント設定の構成
• ドラッグアンドドロップスクリプトファイルまたはディレクトリを使用して、ロジックにコンポーネントを簡単に追加します。
• ロジックエディターでのコンポーネントのグループ化
• エディターでのコンポーネントの表示の設定（反転、最小化、有効化、無効化）
• ロジックエディターから直接コンポーネントコードエディターを開く
• エディターでの起動中に、ロジックエディターでデバッグデータを直接表示する
• ビジュアルロジックエディターのスケーリング
• 突然ロジックに多数のコンポーネントが含まれている場合、選択時にフォーカスを付けて検索する可能性があります（これは変数に適用されます）
  
  
• コンポーネントと変数値の間で送信されたすべてのデータを追跡するUnity3dエディターのシーン起動モードでの段階的なデバッグ
• MonoBehaviourメソッドのサポートと呼び出しの順序の設定。 注 ：ここでは、SOにはデフォルトでStart、Updateなどのメソッドはないことを意味します。 したがって、それらのサポートはコンポーネント自体に追加されています。 同時に、ExecuteOrder属性を使用して、Start、Updateなどのメソッドが呼び出される順序を構成できます。
• インスペクターのCoroutine、async / await、およびすべてのUnity3d属性のサポート、およびCustomPropertyDrawerのサポート

エディターで作業する

エディターでの作業を開始するには、シーンを開いてからエディター自体を起動する必要があります。







エディターを起動した後、シーン（エディターの更新ボタン）を初期化します。その後、既存のロジックを作成またはシーンに追加できます。

ロジック（コンポーネント、それらのパラメーター、コンポーネント間の関係、変数、およびそれらの値を記述するファイル）を作成した後、それを意味で埋めることができます。 コンポーネントまたは変数を追加するには、対応するスクリプトをロジックエディターの領域にドラッグするだけです。 別のオプションは、 ComponentDefinition属性を使用して自動的に生成されるディレクトリを使用することです。







ロジックにいくつかのコンポーネントを追加した後、グループを含めて移動したり、視覚的なグループに結合したりできます。







ビジュアルエディタでコンポーネント自体を表すものをさらに詳しく考えてみましょう。







ここに：

• コンポーネントのメニューボタンをクリックすると、次のことができるドロップダウンメニューが開きます。
  
  
  • コンポーネントを有効化または無効化する
  • コンポーネントを最小化する（これはヘッダーをダブルクリックすることでも実行できます）
  • コンポーネントの反転（入力ポイントと出力ポイントを入れ替える）
  • コンポーネントオプション領域の非表示または表示
  • コンポーネントのコードエディターを開きます
• コンポーネントパラメータの領域は、コンポーネントのキーパラメータの値が表示される場所であり、その構成はプログラマーに依存します

パラメーター（パブリックフィールドまたはSerializeField属性を持つフィールド）を構成するには、ロジックエディターでコンポーネントを選択し、Unity3dインスペクターを開く必要があります。







ここに：

• 右上隅には、ロジックエディターに表示されるヘッダーの色を変更できるボタンがあります
• 名前 -コンポーネントインスタンスの名前を設定するフィールド
• コメント -コンポーネントインスタンスにコメントを設定するためのフィールド;コンポーネントにカーソルを合わせると、ロジックエディターに表示されます
• コンポーネントパラメータ -コンポーネントパラメータが表示される領域（パブリックフィールドおよびSerializeFieldでマークされたフィールド）
• 変数リンク -変数への参照を設定するための領域（変数の詳細については、変数の操作に関するセクションで説明します）。

オブジェクトを視覚的にグループ化するには、オブジェクトを選択してから、右ボタンを押してメニュー内の対応するアイテムを選択する必要があります。 グループの名前を変更したり、配色を変更したりできます。







コンポーネントの視覚的表現をスケーリングするには、マウスホイールを使用します。ここではすべてが非常に簡単です。



そして、最後に注意したいのは、コンポーネント間の接続の操作です。

通信を確立するには、あるコンポーネントの出力ポイントを別のコンポーネントの入力ポイントに接続する必要があります。















関係は、ポイントが送受信するタイプマッチングルールに基づいて確立されます。 データを受信しない入力ポイントに対して例外が作成され、任意の出力ポイントを接続できます。 接続が確立されると、システムはタイプの一致を自動的にチェックし、この接続を確立できるかどうかを表示します。 入力および出力ポイントは、次のクラスを使用してコンポーネントコードで設定されます。

INPUT_POINT OUTPUT_POINT INPUT_POINT<T> OUTPUT_POINT<T>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最初の2つのクラスはパラメーターを受け入れない入力ポイントと出力ポイントに使用され、2番目のクラスはそれぞれパラメーターを受け入れません。 Tはどのタイプでもかまいません。

 public INPUT_POINT <float> InputFloatValue = new INPUT_POINT<float>(); public OUTPUT_POINT <float> OutputFloatValue = new OUTPUT_POINT<float>();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

リンクのチェーンを呼び出すには、実行機能を使用する必要があります。

 OutputFloatValue.Execute(5f);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そのような呼び出しを処理するには、コンポーネントコードの入力ポイントのハンドラーを設定する必要があります（少し後で正確に話す場所について）。

 InputFloatValue.Handler = value => Debug.Log(value);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして最後に、接続に関する重要なポイントに言及したいと思います。 1つのポイントから複数のリンクがある場合は、エディターで呼び出しの順序を調整できます。

変数を操作する

前述のように、変数は、リンクを介してコンポーネント間でデータを共有できる特別なオブジェクトです。 コンポーネントなどの変数は、プログラマーによって作成されます。

 [ComponentDefinition(Name = "Float", Path = "uViLEd Components/Base/Variable/Base", Tooltip = "Variable for a floating-point number", Color = VLEColor.Cyan)] public class VariableFloat : Variable<float> { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ご覧のとおり、変数の基本クラスはジェネリッククラスVariableです。ここで、Tは変数で囲まれたデータの型であり、Tはシリアル化できる任意の型です。



エディターでは、変数は次のように表示されます。







変数値の表示を変更するには、T型のToStringメソッドを再定義するだけです。

 public struct CustomData { public readonly int Value01; public readonly int Value02; public CustomData (int value01, int value02) { Value01= value01; Value02= value02; } public override string ToString() { var stringBuilder = new StringBuilder(); stringBuilder.AppendLine("Value01 = {0}".Fmt(Value01)); stringBuilder.Append("Value02 = {0}".Fmt(Value02)); return stringBuilder.ToString(); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

したがって、このタイプの変数は次のようになります。

 public class VariableCustomData : Variable<CustomData> { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コンポーネントの変数への参照を追加するには、特別なクラスを使用する必要があります。

 public VARIABLE_LINK<CustomData> CustomVariableLink = new VARIABLE_LINK<CustomData>();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その後、リンクはインスペクターで設定でき、ドロップダウンメニューにはCustomDataタイプの変数のみが表示されるため、それらの操作が大幅に簡素化されます。



変数を操作するために、変数の値がいつ変更されたのか、またはいつデータが設定されたのかを判断する特別な方法があります。

 CustomVariableLink.AddSetEventHandler(CustomDataSet); CustomVariableLink.AddChangedEventHandler(CustomDataChanged);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ChangedはEquals条件によって機能するため、構造とクラスを使用する場合は、このメソッドを再定義して正しい動作を確保する必要があることに留意してください。

Unityオブジェクトの使用

uViLEdシステムの機能により、Unityオブジェクトへの直接リンクは、ロジックのロード時に復元できないため、システム内で使用できません。 この問題を解決するために、専用のVLObjectシェルが作成されました。これにより、そのようなリンクを作成したり、リンクを保存およびロードしたりできます。 とりわけ、このシェルには特別なプロパティエディタがあり、これを使用すると、シーン内の任意のオブジェクトからコンポーネントを取得できます（下図を参照）。 VLObjectを使用すると、シーンオブジェクトとそのコンポーネントへのリンクだけでなく、プレハブやテクスチャ、サウンドなどのリソースファイルへのリンクも保存できます。







注 ：既存のロジックが別のシーンで使用される場合、シーンはストレージとして機能するため、プレハブへの参照を含むオブジェクトへの参照は失われます。 ロジックをテンプレートとして使用する場合は、これも考慮する必要があります。この場合、最適なオプションは、外部から（たとえば、シーンにアタッチされたロジックから）必要なリンクを転送することです。



VLObjectにインストールされるUnityオブジェクトのタイプを制限することもできます。 これはUnityインスペクターのみに影響し、それらを操作するために使用されます。

 [SerializeField] [TypeConstraint(typeof(Button))] private VLObject _button;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

論理コンポーネントの作成

ロジックコンポーネントを作成するには、プログラマがプロジェクトに単純なC＃スクリプトファイルを追加し（[プロジェクト]タブの特別なメニューからコンポーネントまたは変数をすぐに作成することもできます）、そのコードを次のように変更するだけで十分です：

 [ComponentDefinition(Name = "MyComponent", Path = "MyFolder/MySubfolder", Tooltip = "this my logic component", Color = VSEColor.Green)] public class MyLogicComponent : LogicComponent { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

前述したように、 ComponentDefinitionはコンポーネントのカタログを自動的に作成できる属性です。ここでは、文字列でHEX形式として色（ヘッダーの色）が指定されていることに注意する必要があります。



LogicComponentはすべてのコンポーネントの基本クラスであり、これはScripatableObjectの子孫です。



以下は、bool型の入力値によって分岐するコンポーネントの簡単な例です。

 public class IfBool : LogicComponent { public INPUT_POINT<bool> ValueToBeChecked = new INPUT_POINT<bool>(); public OUTPUT_POINT True = new OUTPUT_POINT(); public OUTPUT_POINT False = new OUTPUT_POINT(); public override void Constructor() { ValueToBeChecked.Handler = ValueToBeCheckedHandler; } private void ValueToBeCheckedHandler(bool value) { if(value) { True.Execute(); }else { False.Execute(); } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そのため、コードからわかるように、コンポーネントの入力ポイントを作成しました。これは、bool型の値と、取得した値に応じて呼び出される2つの出力ポイントを取ります。



おそらくあなたは今、どのようなコンストラクターですか？ 説明します。 デフォルトでは、 ScriptableObjectはStart 、 Updateなどのメソッドをサポートしていませんが、 Awake 、 OnEnable 、 OnDisable、およびOnDestroyをサポートしています。 そのため、 CreateInstanceメソッドを使用してScriptableObjectが作成された場合、常に目覚め （ OnEnableなど ）が呼び出されますが、実際にはこれが問題です。 エディターモードでのシリアル化のためにオブジェクトがメモリに作成されるという事実により、この時点でコンポーネントコードを動作から除外する必要があったため、 ConstructorメソッドとしてAwakeアナログが追加されました。これは、エディターでオブジェクトを削除するときのOnDisableメソッドとOnDestroyメソッドにも当てはまります。 コンポーネントの削除を正しく処理する必要がある場合（たとえば、シーンをアンロードする場合）、 IDisposableインターフェイスを使用する必要があります。



一般に、ご覧のとおり、コンポーネントを作成するのに難しいことは何もありません。 これは通常のクラスで、任意のコードを含めることができます。 特定のケースでは、コンポーネントには入力ポイントと出力ポイントがまったく含まれない場合がありますが、グローバルメッセージを使用して通信します。 ちなみに、このために、 uViLEdにはGlobalEventクラスがあります-これはデータ型に基づいたメッセージシステムです（詳細については私の記事を参照してください）。



最後に言及したいのは、コンポーネントのパラメーターに応じてコンポーネントの入力ポイントと出力ポイントを構成する機能です。







これを行うには、コンポーネントコードで、 IInputPointParseおよびIOutputPointParseインターフェイスの一方または両方を実装するだけで十分です。 以下は、 Switchブランチコンポーネントの抽象ジェネリッククラスコードの例です; SwitchValuesパラメーターに応じて、出力ポイントはここで自動的に生成されます。

論理デバッグ

UViLEdは、ロジックをデバッグするためのいくつかのメカニズムを提供します。

1. シーン起動モードのロジックエディターで内部変数とその値を表示する機能。 これを行うには、 ViewInDebugMode属性を使用します
2. シーン起動モードで論理変数の値を表示する機能
3. コンポーネント間の呼び出しの段階的なデバッグと、コンポーネント間で転送されるデータの表示の可能性

UViLEdには、最後のアイテム用の特別なモードがあり、シーンの開始時にオンになります。







残念ながら、このモードには、シーン間の移行に関連する特定の制限があります。 この場合、前のシーンとロジックからのデバッグデータは失われ、新しいものでは、ロジックがエディターでアクティブになった瞬間からのみ表示され始めます。

おわりに

この記事では、現在のプロジェクトで使用している開発アプローチを簡単に紹介しようとしました。 最初の懐疑論（私のものを含む）にもかかわらず、特にプロトタイピングの場合、実践はその使用の利便性を著しく示しています。 とりわけ、ゲームデザイナーの作業は大幅に簡素化されており、シーンにい込まず、オブジェクトを突いてゲームプレイをカスタマイズしたり、変数やコンポーネントのデータのセットですべてを簡単に構成できる個別のロジックが作成されたりしません。 また、大きな利点は、私のプロジェクトでは、コンテンツが外部からダウンロードされることが多いという事実です。 ビジュアルロジックエディターを使用すると、メインアプリケーションを更新せずにゲームプロセスのバランスを更新できます。場合によっては、ロジック自体を変更できます。



私自身は、このような開発アプローチは大規模なプロジェクトには適用できないが、もちろん、世界を活性化するためのゲームプレイスクリプトやレベルデザインなどに使用できると考えています。現在進行中のプロジェクト（子供のセグメント）、これまでのところ、彼は素晴らしい結果を示しています。



次は？



これは、ロジックuViLEdのビジュアルエディターに関する一連の記事の最初の部分でしたが、次の部分があります。

1. システムのコア ：ロジックのロードが発生する方法、ScriptableObjectが選択される理由、APIがどのように配置されるか、どのように実行できるかなど、どのような困難が生じ、すべてが解決されたか。
2. 編集者 ：どのように開発されたのか、どのように構築されたのか、どのような問題と解決策など、今私が作り直すもの。

後続の記事で説明したい具体的な質問がある場合は、コメントを記入してください。



PS ： uViLEdの重要なポイントについて話そうとしましたが 、必要に応じて、Asset Storeからプラグインをダウンロードすることでそれに慣れることができます。完全なドキュメント（英語ですが）：ユーザーガイド、プログラマーおよびAPIのガイドがあります。



UViLEdビジュアルロジックエディター

グローバルメッセージング記事