Version: Unity 6.0 (6000.0)
LanguageEnglish
  • C#

Awaitable.WaitForSecondsAsync

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 static Awaitable WaitForSecondsAsync(float seconds, CancellationToken cancellationToken);

Parameters

Parameter Description
seconds Seconds to wait for.
cancellationToken Optional cancellation token.

Description

Resumes execution after the specified number of seconds.

This method can only be called from the main thread and always completes on main thread.

Note:: Awaitable.WaitForSecondsAsync throws OperationCanceledException if the provided CancellationToken is canceled during the wait. This aborts the wait rather than interrupting it and continuing. If you use cancellation to indicate that a task has completed early and expect execution to proceed to subsequent statements, you must handle the exception explicitly or avoid passing a token here. Otherwise, code that awaits a delay with a token and then runs follow-up logic might skip that logic when the token is triggered.

async Awaitable Foo(){
  await Awaitable.WaitForSecondsAsync(2);
  // Do something
  await Awaitable.WaitForSecondsAsync(2);
  // Do something else
}