UMoviePipelinePythonHostExecutor

Copyright Epic Games, Inc. All Rights Reserved.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieRenderPipelineCore

Header

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

Include

#include "MoviePipelinePythonHostExecutor.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class UMoviePipelinePythonHostExecutor : public UMoviePipelineExecutorBase

Remarks

This is a dummy executor that is designed to host a executor implemented in python. Python defined UClasses are not available when the executor is initialized and not all callbacks are available in Python. By inheriting from this in Python and overriding which UClass to latently spawn, this class can just forward certain events onto Python (by overriding the relevant function).

Variables

Name Description

Public variable UProperty Category BlueprintReadWrite

TSubclassOf < UM ...

 

ExecutorClass

You should override this class type on the CDO of the object with your Python type when Python is initialized.

Public variable UProperty Category BlueprintReadWrite Transient

UMoviePipelineQ ...

 

PipelineQueue

Constructors

Functions

Name Description

Public function UFunction Category blueprintnativeevent

void

 

ExecuteDelayed

(
    UMoviePipelineQueue * InPipelin...
)

Python/Blueprint API.

Public function Virtual

void

 

ExecuteDelayed_Implementation

(
    UMoviePipelineQueue * InPipelin...
)

Public function Const UFunction BlueprintPure, Category

UWorld *

 

GetLastLoadedWorld()

Public function UFunction Category blueprintnativeevent

void

 

OnMapLoad

(
    UWorld * InWorld
)

Public function Virtual

void

 

OnMapLoad_Implementation

(
    UWorld * InWorld
)

Overridden from UMoviePipelineExecutorBase

Name Description

Public function Virtual

void

 

CancelAllJobs_Implementation()

You should override this method to implement canceling jobs.

Public function Virtual

void

 

CancelCurrentJob_Implementation()

You only need to override this methond if your executor supports multiple queued jobs.

Public function Virtual

void

 

Execute_Implementation

(
    UMoviePipelineQueue * InPipelin...
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback