Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


WaitWhile

Suspends the coroutine execution until the supplied delegate evaluates to false.
Read time 1 minuteLast updated 5 days ago

Definition

public sealed class WaitWhile : CustomYieldInstruction, IEnumerator

Remarks

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(System.Func{System.Boolean})Initializes a yield instruction with a given delegate to be evaluated.
WaitWhile(System.Func{System.Boolean},System.TimeSpan,System.Action,UnityEngine.WaitTimeoutMode)Initializes a yield instruction with a given delegate to be evaluated.

Inheritance