Unity - Scripting API: WaitWhile

class in UnityEngine

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Your name Your email Suggestion*

Cancel

Description

Suspends the coroutine execution until the supplied delegate evaluates to false.

WaitWhile can only be used with a yield statement in coroutines.

The supplied delegate is executed each frame after MonoBehaviour.Update and before MonoBehaviour.LateUpdate. When the delegate evaluates to false, the coroutine resumes.

using UnityEngine;
using System.Collections;public class WaitWhileExample : MonoBehaviour
{
    public int frame;
    void Start()
    {
        StartCoroutine(Example());
    }
    IEnumerator Example()
    {
        Debug.Log("Waiting for prince/princess to rescue me...");
        yield return new WaitWhile(() => frame < 10);
        Debug.Log("Finally I have been rescued!");
    }
    void Update()
    {
        if (frame <= 10)
        {
            Debug.Log("Frame: " + frame);
            frame++;
        }
    }
}

Constructors

Constructor	Description
WaitWhile	Initializes a yield instruction with a given delegate to be evaluated.

Inherited Members

Properties

Property	Description
keepWaiting	Indicates if coroutine should be kept suspended.