Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

RegisterPauseCallback(int, Func<bool, bool>)

Registers a callback that is called when the user requests to pause or resume a running progress indicator's task.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule
public static void RegisterPauseCallback(int id, Func<bool, bool> callback)

Parameters

id

int
The progress indicator's unique ID.

callback

Func<bool, bool>
This function is called when a request to pause or resume the progress indicator's task is made. It takes a boolean parameter that specifies whether the task needs to pause or resume. When the value is true, the task needs to pause. When the value is false, the task needs to resume. The function returns true if it actually performed the requested action.

Remarks

Additional Resources: Progress.Pause, Progress.Resume, Progress.UnregisterPauseCallback.