前提条件：デベロッパー モードを有効にする
オートコンプリートを設定する前に、Unreal Engine (UE) Python プラグイン に必要なスタブを生成するように指示する必要があります。これを行うには、 Developer Mode (デベロッパー モード) であることを [Editor Preferences (エディタの環境設定)] > [Plugins (プラグイン)] > [Python] で確認してからエディタを再起動します。
PyCharm
[Settings (設定)] ウィンドウを開いて [Project (プロジェクト)] > [Python Interpreter (Phython インタープリタ)] に移動し、歯車アイコンをクリックして [Show all (全て表示)] を選択します。[Python Interpreter (Python インタープリタ)] ウィンドウで [Paths] ボタンをクリックし、次に [+] をクリックすると、スタブ ファイルの場所を追加することができます。
また、インテリセンス ファイルの最大サイズを大きくする必要もあるため、 [Help (ヘルプ)] > [Edit Custom Properties (カスタム プロパティを編集)] に移動して、次を追加します。
idea.max.intellisense.filesize = 25000
PyCharm を再起動すると、オートコンプリート メニューに UE API の関数が表示されるようになります。
VSCode
[Settings] > [Extension (拡張)] > [Python] に移動して [Auto Complete:Extra Paths] を見つけます。リンクをクリックして「settings.json」ファイルを開き、python.autoComplete.extraPaths の下にスタブ ファイルへのパスを追加します。
Visual Studio Code (VSCode) を再起動すると、オートコンプリート メニューに UE API の関数が表示されるようになります。
タイプ ヒンティング
Python プラグインはタイプ ヒンティングを使用してスタブを生成することができるようになりました (タイプ ヒンティングの詳細については、PEP 484 を参照してください)。タイプ ヒンティングは Python IDE オートコンプリート メニューに表示されます。タイプ ヒンティングを設定するには、まず Unreal Editor のメニュー バーにある [Edit (編集)] > [Editor Preferences (エディタ環境設定)] をクリックします。この操作で [Editor Preferences] タブが開きます。[Plugins] > [Python] を選んで Python Script Plugin で使用できるユーザー設定を確認します。タイプ ヒンティングを使用するには、Developer Mode を有効にする必要があります。以下の表は、利用できるタイプ ヒンティングと説明です。
| タイプ ヒンティング | 説明 |
|---|---|
| Auto-Completion | メソッドの正確なパラメータと戻り型を指定します。 |
| Type Checker | 可能なすべての型強制を加算します。例えば、unreal.Name の代わりに Python の文字列を渡すことができることを指定します。これにより、オートコンプリート メニューが忙しくなり、読みにくくなりますが、このオプションは、IDE でタイプチェックをオンにすると、より効果的に機能します。 |
| Off | タイプ ヒンティングをすべてオフにします。 |
デフォルトでは、Type Hinting Mode は Auto-Completion に設定されています。
タイプ ヒンティングは完璧ではないことにご注意ください。スタブ生成時に型がわからない場合があります。また、C++ のリフレクション API は、パラメータやメソッドの戻り値が None になり得るかどうかについて、正確に指定するには十分な情報を提供しない場合もあります。
スタブ ファイルは、エディタ起動のたびに再生成されます。その結果、新しい関数を Python に公開したり、新しいプラグインを有効にした後にエディタを再起動することで、スタブ ファイルが最新であることを確認することができます。