1. Epic GamesDeveloper
  3. UMoviePipelineSetting

UMoviePipelineSetting

A base class for all Movie Render Pipeline settings.

Unreal Engine C++ API Reference > Plugins > MovieRenderPipelineCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Abstract&41;  
class UMoviePipelineSetting : public UObject

Remarks

A base class for all Movie Render Pipeline settings.

Variables

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Virtual void Called once when all files have been finalized.
Public function Const UFunction BlueprintCallable, Category void

BuildNewProcessCommandLineArgs ( TArray< FString >& InOutUnrealURLParams,
TArray< FString >& InOutCommandLineArgs,
TArray< FString >& InOutDeviceProfileCvars,
TArray< FString >& InOutExecCmds
)

  
Public function Virtual Const void

BuildNewProcessCommandLineArgsImpl ( TArray< FString >& InOutUnrealURLParams,
TArray< FString >& InOutCommandLineArgs,
TArray< FString >& InOutDeviceProfileCvars,
TArray< FString >& InOutExecCmds
)

 Modify the Unreal URL and Command Line Arguments when preparing the setting to be run in a new process.
Public function Virtual Const bool Can this setting be disabled? UI only.
Public function Virtual Const FText Warning: This gets called on the CDO of the object
Public function FText What tooltip should be displayed for this setting when hovered in the tree list?
Public function const FSlateBrush * What icon should this setting use when displayed in the tree list.
Public function Virtual Const FText Warning: This gets called on the CDO of the object
Public function Virtual Const FText Return a string to show in the footer of the details panel.
Public function Virtual Const void Return Key/Value pairs that you wish to be usable in the Output File Name format string or file metadata.
Protected function Const UMoviePipeline *  
Public function Virtual Const int32 Higher priority settings are run after lower priority settings when setting up shots during rendering.
Public function Virtual Const TArray< FText > Get a human-readable text describing what validation errors (if any) the call to ValidateState() produced.
Public function Virtual Const EMoviePipelineValidationState Validation.
Public function Virtual Const UWorld *  
Public function bool Post Finalize Export.
Public function Virtual bool Has this setting finished any export-related things it needs to do post-finalize?
Public function Virtual Const bool If true, then this setting will be included when searching for settings even if it was added transiently.
Public function Virtual Const UFunction BlueprintPure, Category bool Is this setting enabled by the user in the UI?
Public function Virtual Const bool

IsSolo ()

 Can only one of these settings objects be active in a valid pipeline?
Public function Virtual Const bool Can this configuration setting be added to the primary configuration? If not, it will throw an error when trying to add it to the primary configuration.
Public function Virtual Const bool Can this configuration setting be added to shots? If not, it will throw an error when trying to add it to a shot config.
Public function void This is called once on a setting when the movie pipeline is first set up.
Public function void This is called once on a setting when the movie pipeline is shut down.
Public function void Called only on settings that have been added to the Primary Configuration to let you know that a shot is about to be rendered.
Protected function Virtual void  
Public function void Called only on settings that have been added to the Primary Configuration to let you know that a shot has finished rendering and is being torn down.
Protected function Virtual void  
Public function Virtual UFunction BlueprintCallable, Category void

SetIsEnabled ( bool bInEnabled
)

  
Protected function Virtual void  
Protected function Virtual void  
Public function void Attempt to validate the configuration the user has chosen for this setting.
Public function Virtual void Attempt to validate the configuration the user has chosen for this setting.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Deprecated Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category void

BuildNewProcessCommandLine ( FString& InOutUnrealURLParams,
FString& InOutCommandLineArgs
)

 Use BuildNewProcessCommandLineArgs instead.
Public function Virtual Const void

BuildNewProcessCommandLineImpl ( FString& InOutUnrealURLParams,
FString& InOutCommandLineArgs
)

 Use BuildNewProcessCommandLineArgsImpl instead.
Public function Virtual Const bool IsValidOnMaster is deprecated. Please use IsValidOnPrimary instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page