unreal.ScopedSlowTask

class unreal.ScopedSlowTask(*args, **kwargs)

Bases: object

Type used to create and managed a scoped slow task in Python

__enter__() → self -- begin this slow task

__exit__(type, value, traceback) → None -- end this slow task

enter_progress_frame(work=1.0, desc=Text()) -> None -- indicate that we are to enter a frame that will take up the specified amount of work (completes any previous frames)

make_dialog(can_cancel=False, allow_in_pie=False) → None -- creates a new dialog for this slow task, if there is currently not one open

make_dialog_delayed(delay, can_cancel=False, allow_in_pie=False) → None -- creates a new dialog for this slow task after the given time threshold. If the task completes before this time, no dialog will be shown

should_cancel() → bool -- True if the user has requested that the slow task be canceled