Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MovieRenderPipelineCore > UMoviePipelineSetting

Light Theme

Dark Theme

UMoviePipelineSetting

A base class for all Movie Render Pipeline settings.

Windows

MacOS

Linux

Inheritance Hierarchy

References

Module	MovieRenderPipelineCore
Header	/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineSetting.h
Include	#include "MoviePipelineSetting.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Abstract)
class UMoviePipelineSetting : public UObject

Remarks

A base class for all Movie Render Pipeline settings.

Variables

		Name	Description
	TArray< FText >	ValidationResults	If ValidationState isn't valid, what text do we want to show the user to explain to them why?
	EMoviePipelineV...	ValidationState	What was the result of the last call to ValidateState()

Constructors

	Name	Description
	UMoviePipelineSetting()

Functions

	Name	Description
void	BeginExport()
void	BeginExportImpl()	Called once when all files have been finalized.
void	BuildNewProcessCommandLine ( FString& InOutUnrealURLParams, FString& InOutCommandLineArgs )	When rendering in a new process some settings may need to provide command line arguments to affect engine settings that need to be set before most of the engine boots up.
void	BuildNewProcessCommandLineImpl ( FString& InOutUnrealURLParams, FString& InOutCommandLineArgs )	Modify the Unreal URL and Command Line Arguments when preparing the setting to be run in a new process.
bool	CanBeDisabled()	Can this setting be disabled? UI only.
FText	GetCategoryText()	Warning: This gets called on the CDO of the object
FText	GetDescriptionText()	What tooltip should be displayed for this setting when hovered in the tree list?
const FSlate...	GetDisplayIcon()	What icon should this setting use when displayed in the tree list.
FText	GetDisplayText()	Warning: This gets called on the CDO of the object
void	GetFilenameFormatArguments ( FMoviePipelineFormatArgs& InOutFor... )	Return Key/Value pairs that you wish to be usable in the Output File Name format string.
FText	GetFooterText ( UMoviePipelineExecutorJob* InJ... )	Return a string to show in the footer of the details panel.
bool	GetIsUserCustomized()
UMoviePipeli...	GetPipeline()
TArray< FTex...	GetValidationResults()	Get a human-readable text describing what validation errors (if any) the call to ValidateState() produced.
EMoviePipeli...	GetValidationState()	Validation.
UWorld *	GetWorld()
bool	HasFinishedExporting()	Post Finalize Export.
bool	HasFinishedExportingImpl()	Has this setting finished any export-related things it needs to do post-finalize?
bool	IsEnabled()	Is this setting enabled by the user in the UI?
bool	IsSolo()	Can only one of these settings objects be active in a valid pipeline?
bool	IsValidOnMaster()	Can this configuration setting be added to the master configuration? If not, it will throw an error when trying to add it to the master configuration.
bool	IsValidOnShots()	Can this configuration setting be added to shots? If not, it will throw an error when trying to add it to a shot config.
void	OnMoviePipelineInitialized ( UMoviePipeline* InPipeline )	This is called once on a setting when the movie pipeline is first set up.
void	OnMoviePipelineShutdown ( UMoviePipeline* InPipeline )	This is called once on a setting when the movie pipeline is shut down.
void	SetIsEnabled ( bool bInEnabled )
void	SetIsUserCustomized ( bool bIsUserCustomized )
void	SetupForPipelineImpl ( UMoviePipeline* InPipeline )
void	TeardownForPipelineImpl ( UMoviePipeline* InPipeline )
void	ValidateState()	Attempt to validate the configuration the user has chosen for this setting.
void	ValidateStateImpl()	Attempt to validate the configuration the user has chosen for this setting.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss