Yield 命令リファレンス
コルーチンメソッドで異なるカスタム命令を実行して、再開するタイミングをコントロールします。
読み終わるまでの所要時間 7 分最終更新 3日前
コルーチンは、ステートメントで実行をサスペンドします。は、次のフレームまでコルーチンの実行を一時停止します。ただし、は Unity エディターやランタイムに、例えば指定された時間だけ待機したり、条件が満たされるまでコルーチンの実行を再開するように指示を返すこともできます。
yield returnyield return nullyield returnランタイム yield 命令
Unity には、 から派生したカスタムの yield 命令のセットがあり、指定した時間が経過した後、指定した条件が満たされたとき、またはプレイヤーループの特定の時点で再開するために使用できます。
UnityEngine.YieldInstruction指示 | 説明 |
|---|---|
| コルーチンを中断し、シーンやアセットの読み込みなどの非同期操作が完了したときに再開します。 |
| コルーチンを中断し、すべてのレンダリングと GUI イベントの後のフレームの終了時に再開します。 注： エディターがバッチモードのとき、スクリプトに |
| コルーチンを中断し、 すべての物理演算後の次の物理演算更新の終了時に再開します 。 |
| コルーチンを中断し、タイムスケールをアカウントして指定された秒数が経過した後に再開します。 |
| コルーチンを中断し、指定された秒数が経過した後にタイムスケールを無視して再開します。 |
| コルーチンを中断し、指定されたデリゲートが |
| コルーチンを中断し、指定されたデリゲートが |
これらの yield 命令の詳細と使用例については、API リファレンスのページを参照してください。
プレイヤーループで異なるコルーチンが再開される場所を視覚的に示すには、イベント機能実行順の図を参照してください。
UnityTest yield 命令
[UnityTest]指示 | 説明 |
|---|---|
| Unity エディターが再生モードに入るための yield 命令を作成します。 |
| Unity エディターが再生モードを終了するための yield 命令を作成します。 |
| Unity エディターでスクリプトの再コンパイルをトリガーします。 |
| 受信ドメインのリロード後までスクリプトの実行を遅らせます。 |
Unity Test Framework が提供する収率命令の詳細は、エディタの収率命令 を参照してください。
エディターの yield 命令
Editor Coroutines パッケージは、Unity エディターの編集モードで実行されるコルーチンのサポートを追加します。パッケージには、編集モードコルーチンの追加の yield 命令が含まれています。
指示 | 説明 |
|---|---|
| アカウントのタイムスケールを考慮して、指定された秒数が経過した後に EditorCoroutine を再開します。 |
詳細については、Editor Coroutines を参照してください。
バッチモードのサポート
スタンドアロン プレイヤーをバッチ モードで実行する場合、ランタイム コルーチン yield 命令はすべて法線として実行されます。
バッチモードでエディタを実行し、プロジェクトにまたはマークが付けられ、編集モードでも実行されるスクリプトがある場合、を除くそれらのスクリプトのすべてのランタイムコルーチンは編集モードで実行されます。これは、すべての Unity サブシステムが編集モードでランタイムほど頻繁に更新されないためです。詳細については、 API リファレンス を参照してください。
[ExecuteInEditMode][ExecuteAlways]WaitForEndOfFrame[ExecuteAlways]追加リソース
- コマンドライン引数
- API リファレンス