UMoviePipelineExecutorBase::SetStatusProgress

Set the progress of this Executor.

Windows
MacOS
Linux

References

Module

MovieRenderPipelineCore

Header

/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineExecutor.h

Include

#include "MoviePipelineExecutor.h"

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, BlueprintNativeEvent, Category="Movie Render Pipeline")
void SetStatusProgress
(
    const float InProgress
)

Remarks

Set the progress of this Executor. Does nothing in default implementations, but a useful shorthand for implementations to broadcast progress updates, ie: You can call SetStatusProgress as your executor changes progress, and override the SetStatusProgress function to make it actually do something (such as printing to a log or updating a third party API).

Does not necessairly reflect the overall progress of the work, it is an arbitrary 0-1 value that can be used to indicate different things (depending on implementation).

For C++ implementations override `virtual bool SetStatusProgress_Implementation() override_ For Python/BP implementations override .ufunction(override=True) def set_status_progress(self, inStatus):

Parameters

Parameter

Description

InProgress

The progress (0-1 range) the executor should have.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss