WaitUntil
Suspends the coroutine execution until the supplied delegate evaluates to true.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: CustomYieldInstruction
- Implements: IEnumerator
public sealed class WaitUntil : CustomYieldInstruction, IEnumerator
Remarks
WaitUntilyieldThe supplied delegate is executed each frame after MonoBehaviour.Update() and before MonoBehaviour.LateUpdate(). When the delegate evaluates to , the coroutine resumes.
trueAdditional Resources: AsyncOperation, WaitForEndOfFrame, WaitForFixedUpdate, WaitForSeconds, WaitForSecondsRealtime, WaitWhile.
Examples
using UnityEngine;using System.Collections;public class WaitUntilExample : MonoBehaviour{ public int frame; void Start() { StartCoroutine(Example()); } IEnumerator Example() { Debug.Log("Waiting for princess to be rescued..."); yield return new WaitUntil(() => frame >= 10); Debug.Log("Princess was rescued!"); } void Update() { if (frame <= 10) { Debug.Log("Frame: " + frame); frame++; } }}
Constructors
Constructor | Description |
|---|---|
| WaitUntil(System.Func{System.Boolean}) | Initializes a yield instruction with a given delegate to be evaluated. |
| WaitUntil(System.Func{System.Boolean},System.TimeSpan,System.Action,UnityEngine.WaitTimeoutMode) | Initializes a yield instruction with a given delegate to be evaluated. |