1. Epic GamesDeveloper
  3. UMoviePipelineExecutorJob

UMoviePipelineExecutorJob

A particular job within the Queue

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

A particular job within the Queue

   
Name UMoviePipelineExecutorJob
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueue.h
Include Path #include "MoviePipelineQueue.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UMoviePipelineExecutorJob : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMoviePipelineExecutorJob()

   MoviePipelineQueue.h  

Typedefs

Name Type Remarks Include Path
FOnSequenceSet TMulticastDelegate_TwoParams< void, UMoviePipelineExecutorJob *Job, ULevelSequence *Sequence >   MoviePipelineQueue.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Author FString (Optional) If left blank, will default to system username. MoviePipelineQueue.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Movie Render Pipeline"
Comment FString (Optional) If specified, will be shown in the burn in to allow users to keep track of notes about a render. MoviePipelineQueue.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Movie Render Pipeline"
  • Meta=(MultiLine=true)
ConsoleVariableOverrides TArray< FMoviePipelineConsoleVariableEntry > (Optional) Console variable overrides which are applied after cvars set via nodes. MoviePipelineQueue.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Console Variable Overrides"
  • Meta=(DisplayName="Console Variables", EditCondition="IsUsingGraphConfiguration()", EditConditionHides)
JobName FString (Optional) Name of the job. Shown on the default burn-in. MoviePipelineQueue.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Movie Render Pipeline"
Map FSoftObjectPath Which map should this job render on MoviePipelineQueue.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Movie Render Pipeline"
  • Meta=(AllowedClasses="/Script/Engine.World")
OnJobGraphPresetChanged FOnMoviePipelineJobGraphPresetChanged Called when the graph preset assigned to the job changes. MoviePipelineQueue.h  
Sequence FSoftObjectPath Which sequence should this job render? MoviePipelineQueue.h
  • BlueprintReadWrite
  • EditAnywhere
  • BlueprintSetter="SetSequence"
  • Category="Movie Render Pipeline"
  • Meta=(AllowedClasses="/Script/LevelSequence.LevelSequence")
ShotInfo TArray< TObjectPtr< UMoviePipelineExecutorShot > > (Optional) Shot specific information. MoviePipelineQueue.h
  • BlueprintReadWrite
  • Instanced
  • Category="Movie Render Pipeline"
UserData FString Arbitrary data that can be associated with the job. MoviePipelineQueue.h
  • BlueprintReadWrite
  • Category="Movie Render Pipeline"

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnabled bool Whether this job is enabled and should be rendered. MoviePipelineQueue.h  
bIsConsumed bool   MoviePipelineQueue.h
  • Transient
Configuration TObjectPtr< UMoviePipelinePrimaryConfig >   MoviePipelineQueue.h
  • Instanced
GraphPreset TSoftObjectPtr< UMovieGraphConfig > The graph-based configuration preset that this job is using. Can be nullptr. MoviePipelineQueue.h  
GraphVariableAssignments TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > > Overrides on the variables in the graph (and subgraphs) associated with this job. MoviePipelineQueue.h
  • EditAnywhere
  • Instanced
  • Category="Variable Assignments"
PresetOrigin TSoftObjectPtr< UMoviePipelinePrimaryConfig >   MoviePipelineQueue.h  
StatusMessage FString   MoviePipelineQueue.h
  • Transient
StatusProgress float   MoviePipelineQueue.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers
Gets the configuration for the job. MoviePipelineQueue.h
  • BlueprintPure
  • Category="Movie Render Pipeline"
Gets the graph-style preset that this job is using. MoviePipelineQueue.h
  • BlueprintPure
  • Category="Movie Render Pipeline"
Gets overrides on the variables in graph presets associated with this job. MoviePipelineQueue.h  
This method will return you the object which contains variable overrides for the Primary Graph assigned to this job. MoviePipelineQueue.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"
  • DisplayName="Get or Create Variable Overrides"
  • Meta=(ScriptName="GetOrCreateVariableOverrides")
Gets the preset for this job, but only if the preset has not been modified. MoviePipelineQueue.h
  • BlueprintPure
  • Category="Movie Render Pipeline"
Get the current status message for this job. MoviePipelineQueue.h
  • BlueprintPure
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"
Get the current progress as last set by SetStatusProgress. MoviePipelineQueue.h
  • BlueprintPure
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

bool IsConsumed ()

 Gets whether or not the job has been marked as being consumed. MoviePipelineQueue.h
  • BlueprintPure
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

bool IsEnabled ()

 Gets whether or not the job has been marked as being enabled. MoviePipelineQueue.h
  • BlueprintPure
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

bool IsUsingGraphConfiguration()

 Returns true if this job is using graph-style configuration, else false. MoviePipelineQueue.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

void OnDuplicated ()

 Should be called to clear status and user data after duplication so that jobs stay unique and don't pick up ids or other unwanted behavior from the pareant job. MoviePipelineQueue.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

void RefreshAllVariableAssignments()

 Refreshes the variable assignments associated with this job, both for the jobs's own graph preset and the associated shot graphs. MoviePipelineQueue.h  

void SetConfiguration ( UMoviePipelinePrimaryConfig* InPreset
)

   MoviePipelineQueue.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

void SetConsumed ( const bool bInConsumed
)

 Set the job to be consumed. MoviePipelineQueue.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

void SetGraphPreset ( const UMovieGraphConfig* InGraphPreset,
const bool bUpdateVariableAssignments
)

 Sets the graph-style preset that this job will use. MoviePipelineQueue.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

void SetIsEnabled ( const bool bInEnabled
)

 Set the job to be enabled/disabled. MoviePipelineQueue.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

void SetPresetOrigin ( UMoviePipelinePrimaryConfig* InPreset
)

   MoviePipelineQueue.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

void SetSequence ( FSoftObjectPath InSequence
)

   MoviePipelineQueue.h
  • BlueprintSetter
  • Category="Movie Render Pipeline"

void SetStatusMessage ( const FString& InStatus
)

 Set the status of this job to the given value. MoviePipelineQueue.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

void SetStatusProgress ( const float InProgress
)

 Set the progress of this job to the given value. MoviePipelineQueue.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="Movie Render Pipeline"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MoviePipelineQueue.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   MoviePipelineQueue.h  

virtual void PostLoad()

   MoviePipelineQueue.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   MoviePipelineQueue.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual FString GetStatusMessage_Implementation()

   MoviePipelineQueue.h  

virtual float GetStatusProgress_Implementation()

   MoviePipelineQueue.h  

virtual bool IsConsumed_Implementation()

   MoviePipelineQueue.h  

virtual bool IsEnabled_Implementation()

   MoviePipelineQueue.h  

virtual void OnDuplicated_Implementation()

   MoviePipelineQueue.h  

void OnGraphPreSave ( UObject* InObject,
FObjectPreSaveContext InObjectPreSaveContext
)

   MoviePipelineQueue.h  

virtual void SetConsumed_Implementation ( const bool bInConsumed
)

   MoviePipelineQueue.h  

virtual void SetIsEnabled_Implementation ( const bool bInEnabled
)

   MoviePipelineQueue.h  

virtual void SetStatusMessage_Implementation ( const FString& InMessage
)

   MoviePipelineQueue.h  

virtual void SetStatusProgress_Implementation ( const float InProgress
)

   MoviePipelineQueue.h  

Static

Name Remarks Include Path Unreal Specifiers

static FOnSequenceSet & OnSequenceSetEvent()

 Retrieve multicast delegate for when a sequence is set. MoviePipelineQueue.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page