UMoviePipelineConsoleVariableSetting | Unreal Engine 4.27 Documentation

Inheritance Hierarchy


Module	MovieRenderPipelineSettings
Header	/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineSettings/Public/MoviePipelineConsoleVariableSetting.h
Include	#include "MoviePipelineConsoleVariableSetting.h"

UCLASS&40;BlueprintType&41;  
class UMoviePipelineConsoleVariableSetting : public UMoviePipelineSetting

Type	Name	Description
TArray< TScriptInterface< IMovieSceneConsoleVariableTrackInterface > >	ConsoleVariablePresets	Note that the interface is used here instead of directly using UConsoleVariablesAsset in order to not depend on the Console Variables Editor.
TArray< FString >	EndConsoleCommands	An array of console commands to execute when this shot is finished.
TArray< FString >	StartConsoleCommands	An array of console commands to execute when this shot is started.

Type	Name	Description
bool	AddConsoleVariable ( const FString& Name, const float Value )	Adds a console variable override with the given name and value, and will add a duplicate if one with the provided name already exists.
bool	AddOrUpdateConsoleVariable ( const FString& Name, const float Value )	Adds a console variable override with the given name and value if one does not already exist.
void	ApplyCVarSettings ( const bool bOverrideValues )
TArray< FMoviePipelineConsoleVariableEntry >	GetConsoleVariables ()	Gets a copy of all console variable overrides.
FMoviePipelineConsoleVariableEntry *	GetCVarAtIndex ( const int32 InIndex )	Returns the console variable entry at the specified index, else nullptr if the index is invalid.
bool	RemoveConsoleVariable ( const FString& Name, const bool bRemoveAllInstances )	Removes the console variable override with the specified name.
FString	ResolveDisabledValue ( const FMoviePipelineConsoleVariableEntry& InEntry )	Returns the value of the console variable if the given entry were to be disabled in this setting.
FString	ResolvePresetValue ( const FString& InCVarName )	Returns the value of the given console variable within the presets for this setting.
bool	UpdateConsoleVariableEnableState ( const FString& Name, const bool bIsEnabled )	Updates the enable state of the console variable override with the provided name.

Type	Name	Description
FText	GetDisplayText ()	Warning: This gets called on the CDO of the object
FText	GetFooterText ( UMoviePipelineExecutorJob* InJob )	Return a string to show in the footer of the details panel.
int32	GetPriority ()	This needs to be higher priority than the Game Override setting so that the values the user specifies for cvars here are the ones actually applied during renders otherwise the Scalability Settings of the Game Override setting can change values away from what the user expects.
bool	IsValidOnPrimary ()	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.
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	SetupForPipelineImpl ( UMoviePipeline* InPipeline )
void	TeardownForPipelineImpl ( UMoviePipeline* InPipeline )

	Type	Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent )	This alternate version of PostEditChange is called when properties inside structs are modified.
	void	PostLoad ()	Do any object-specific cleanup required immediately after loading an object.

	Type	Name	Description
	TMap< FString, float >	ConsoleVariables_DEPRECATED	ConsoleVariables has been deprecated. Please use the console variable getters/setters (GetConsoleVariables(), RemoveConsoleVariable(), AddOrUpdateConsoleVariable(), and UpdateConsoleVariableEnableState()) instead. If scripting modifies ConsoleVariables, MRQ must be run in PIE to ensure changes are migrated.