Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

WaitUntil Constructor

Suggest a change

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.

Close

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.

Close

Cancel

Declaration

public WaitUntil(Func<bool> predicate);

Parameters

predicate Supplied delegate will be evaluated each frame after MonoBehaviour.Update and before MonoBehaviour.LateUpdate until delegate returns true.

Description

Initializes a yield instruction with a given delegate to be evaluated.


Declaration

public WaitUntil(Func<bool> predicate, TimeSpan timeout, Unity.Android.Gradle.Manifest.Action onTimeout, WaitTimeoutMode timeoutMode);

Parameters

predicate Supplied delegate will be evaluated each frame after MonoBehaviour.Update and before MonoBehaviour.LateUpdate until delegate returns true.
timeout Maximum time to wait after creation of the instance for the predicate to return true.
onTimeout The action to perform when the timeout is reached. Only performed if the predicate fails to return true before the maximum time specified.
timeoutMode Mode in which to measure time to determine timeout. Real time by default. Can be set to in-game time, which is scaled according to the value of Time.timeScale.

Description

Initializes a yield instruction with a given delegate to be evaluated.

using UnityEngine;
using System;
using System.Collections;

public class WaitUntilExample : MonoBehaviour { public bool buttonPressed;

void Start() { StartCoroutine(Example()); }

IEnumerator Example() { Debug.Log("Waiting for button to be pressed..."); yield return new WaitUntil(() => buttonPressed, TimeSpan.FromSeconds(3), () => Debug.Log("button was not pressed in time!")); } }