Version: 2021.3
LanguageEnglish
  • C#

Progress.Cancel

Leave feedback
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 bool Cancel(int id);

Parameters

id The progress indicator's unique ID.

Returns

bool True if the associated task is cancelled, false if it cannot be cancelled.

Description

Cancels a runnning progress indicator, and invokes the cancel callback for the associated task.

You can only call this method if a cancel callback has been registered for the specified id.
Additional resources: Progress.RegisterCancelCallback, Progress.UnregisterCancelCallback.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2024 Unity Technologies. Publication Date: 2024-11-05.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information