1. Epic GamesDeveloper
  3. UMoviePipelineExecutorJob

UMoviePipelineExecutorJob

A particular job within the Queue

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType&41;  
class UMoviePipelineExecutorJob : public UObject

Remarks

A particular job within the Queue

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString Author (Optional) If left blank, will default to system username.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString Comment (Optional) If specified, will be shown in the burn in to allow users to keep track of notes about a render.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString JobName (Optional) Name of the job. Shown on the default burn-in.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FSoftObjectPath Map Which map should this job render on
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter FSoftObjectPath Sequence Which sequence should this job render?
Public variable UProperty Category BlueprintReadWrite instanced TArray< TObjectPtr< UMoviePipelineExecutorShot > > ShotInfo (Optional) Shot specific information.
Public variable UProperty Category BlueprintReadWrite FString UserData Arbitrary data that can be associated with the job.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite instanced TObjectPtr< UMovieJobVariableAssignmentContainer > VariableAssignments Overrides on the variables in graph preset associated with this job.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category UMoviePipelinePrimaryConfig * Gets the configuration for the job.
Public function Const UFunction BlueprintPure, Category UMovieGraphConfig * Gets the graph-style config that this job is using.
Public function Const UFunction BlueprintPure, Category UMovieGraphConfig * Gets the graph-style preset that this job is using.
Public function Const UFunction BlueprintPure, Category UMoviePipelinePrimaryConfig * Gets the preset for this job, but only if the preset has not been modified.
Public function Const UFunction BlueprintPure, Category blueprintnativeevent FString Get the current status message for this job.
Protected function Virtual Const FString  
Public function Const UFunction BlueprintPure, Category blueprintnativeevent float Get the current progress as last set by SetStatusProgress.
Protected function Virtual Const float  
Public function Const UFunction BlueprintPure, Category blueprintnativeevent bool Gets whether or not the job has been marked as being consumed.
Protected function Virtual Const bool  
Public function Const UFunction BlueprintPure, Category blueprintnativeevent bool Gets whether or not the job has been marked as being enabled.
Protected function Virtual Const bool  
Public function Const UFunction BlueprintPure, Category bool Returns true if this job is using graph-style configuration, else false.
Public function UFunction BlueprintCallable, Category blueprintnativeevent void 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.
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

SetConsumed ( const bool bInConsumed
)

 Set the job to be consumed.
Protected function Virtual void

SetConsumed_Implementation ( const bool bInConsumed
)

  
Public function UFunction BlueprintCallable, Category void

SetGraphConfig ( UMovieGraphConfig* InGraphConfig
)

 Sets the graph-style config that this job will use.
Public function UFunction BlueprintCallable, Category void

SetGraphPreset ( const UMovieGraphConfig* InGraphPreset
)

 Sets the graph-style preset that this job will use.
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

SetIsEnabled ( const bool bInEnabled
)

 Set the job to be enabled/disabled.
Protected function Virtual void

SetIsEnabled_Implementation ( const bool bInEnabled
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction Category blueprintsetter void

SetSequence ( FSoftObjectPath InSequence
)

  
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

SetStatusMessage ( const FString& InStatus
)

 Set the status of this job to the given value.
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

SetStatusProgress ( const float InProgress
)

 Set the progress of this job to the given value.
Protected function Virtual void

SetStatusProgress_Implementation ( const float InProgress
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page