UMoviePipelineExecutorJob

A particular job within the Queue

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMoviePipelineExecutorJob

References

Module

MovieRenderPipelineCore

Header

/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueue.h

Include

#include "MoviePipelineQueue.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UMoviePipelineExecutorJob : public UObject

Remarks

A particular job within the Queue

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FString

 

Author

(Optional) Name of the person who submitted the job.

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< UMovieP...

 

ShotInfo

(Optional) Shot specific information.

Public variable UProperty Category BlueprintReadWrite

FString

 

UserData

Arbitrary data that can be associated with the job.

Constructors

Name Description

Public function

UMoviePipelineExecutorJob()

Functions

Name Description

Public function Const UFunction BlueprintPure, Category

UMoviePipeli...

 

GetConfiguration()

Public function Const UFunction BlueprintPure, Category

UMoviePipeli...

 

GetPresetOrigin()

Public function Const UFunction BlueprintPure, Category blueprintnativeevent

FString

 

GetStatusMessage()

Get the current status message for this job.

Protected function Virtual Const

FString

 

GetStatusMessage_Implementation()

Public function Const UFunction BlueprintPure, Category blueprintnativeevent

float

 

GetStatusProgress()

Get the current progress as last set by SetStatusProgress.

Protected function Virtual Const

float

 

GetStatusProgress_Implementation()

Public function Const UFunction BlueprintPure, Category blueprintnativeevent

bool

 

IsConsumed()

Gets whether or not the job has been marked as being consumed.

Protected function Virtual Const

bool

 

IsConsumed_Implementation()

Public function UFunction BlueprintCallable, Category blueprintnativeevent

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.

Protected function Virtual

void

 

OnDuplicated_Implementation()

Public function UFunction BlueprintCallable, Category

void

 

SetConfiguration

(
    UMoviePipelineMasterConfig* In...
)

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

 

SetPresetOrigin

(
    UMoviePipelineMasterConfig* In...
)

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

 

SetStatusMessage_Implementation

(
    const FString& InMessage
)

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

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss