UMoviePipelineExecutorBase::SetStatusMessage

Set the status 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 SetStatusMessage
(
    const FString & InStatus
)

Remarks

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

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

Parameters

Parameter

Description

InStatus

The status message you wish the executor to 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