1. Epic GamesDeveloper
  3. UMoviePipelineConsoleVariableSetting

UMoviePipelineConsoleVariableSetting

API > API/Plugins > API/Plugins/MovieRenderPipelineSettings

   
Name UMoviePipelineConsoleVariableSetting
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineSettings/Public/MoviePipelineConsoleVariableSetting.h
Include Path #include "MoviePipelineConsoleVariableSetting.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UMoviePipelineConsoleVariableSetting : public UMoviePipelineSetting

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ConsoleVariablePresets TArray< TScriptInterface< IMovieSceneConsoleVariableTrackInterface > > Note that the interface is used here instead of directly using UConsoleVariablesAsset in order to not depend on the Console Variables Editor. MoviePipelineConsoleVariableSetting.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Settings"
EndConsoleCommands TArray< FString > An array of console commands to execute when this shot is finished. MoviePipelineConsoleVariableSetting.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Settings"
StartConsoleCommands TArray< FString > An array of console commands to execute when this shot is started. MoviePipelineConsoleVariableSetting.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Settings"

Protected

Name Type Remarks Include Path Unreal Specifiers
CVars TArray< FMoviePipelineConsoleVariableEntry > An array of console variable overrides which are applied during render and reverted after the render completes. MoviePipelineConsoleVariableSetting.h
  • EditAnywhere
  • Category="Settings"
  • Meta=(DisplayName="Console Variables", DisplayAfter="ConsoleVariablePresets", ScriptNoExport)
MergedConsoleVariables TArray< FMoviePipelineConsoleVariableEntry > Merged result of preset cvars and override cvars. MoviePipelineConsoleVariableSetting.h  
PreviousConsoleVariableValues TArray< float >   MoviePipelineConsoleVariableSetting.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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. MoviePipelineConsoleVariableSetting.h
  • BlueprintCallable
  • Category="Settings"

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. MoviePipelineConsoleVariableSetting.h
  • BlueprintCallable
  • Category="Settings"
Gets a copy of all console variable overrides. MoviePipelineConsoleVariableSetting.h
  • BlueprintCallable
  • Category="Settings"

FMoviePipelineConsoleVariableEntry * GetCVarAtIndex ( const int32 InIndex
)

 Returns the console variable entry at the specified index, else nullptr if the index is invalid. MoviePipelineConsoleVariableSetting.h  

bool RemoveConsoleVariable ( const FString& Name,
const bool bRemoveAllInstances
)

 Removes the console variable override with the specified name. MoviePipelineConsoleVariableSetting.h
  • BlueprintCallable
  • Category="Settings"
Returns the value of the console variable if the given entry were to be disabled in this setting. MoviePipelineConsoleVariableSetting.h  

FString ResolvePresetValue ( const FString& InCVarName
) const

 Returns the value of the given console variable within the presets for this setting. MoviePipelineConsoleVariableSetting.h  

bool UpdateConsoleVariableEnableState ( const FString& Name,
const bool bIsEnabled
)

 Updates the enable state of the console variable override with the provided name. MoviePipelineConsoleVariableSetting.h
  • BlueprintCallable
  • Category="Settings"

Overridden from UMoviePipelineSetting

Name Remarks Include Path Unreal Specifiers

virtual FText GetDisplayText()

   MoviePipelineConsoleVariableSetting.h  

virtual FText GetFooterText ( UMoviePipelineExecutorJob* InJob
) const

   MoviePipelineConsoleVariableSetting.h  

virtual 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. MoviePipelineConsoleVariableSetting.h  

virtual bool IsValidOnPrimary()

   MoviePipelineConsoleVariableSetting.h  

virtual bool IsValidOnShots()

   MoviePipelineConsoleVariableSetting.h  

virtual void SetupForPipelineImpl ( UMoviePipeline* InPipeline
)

   MoviePipelineConsoleVariableSetting.h  

virtual void TeardownForPipelineImpl ( UMoviePipeline* InPipeline
)

   MoviePipelineConsoleVariableSetting.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ApplyCVarSettings ( const bool bOverrideValues
)

   MoviePipelineConsoleVariableSetting.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page