Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MovieRenderPipelineCore > UMoviePipelinePythonHostExecutor

Light Theme

Dark Theme

UMoviePipelinePythonHostExecutor

Copyright Epic Games, Inc. All Rights Reserved.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMoviePipelineExecutorBase

UMoviePipelinePythonHostExecutor

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
	TSubclassOf< UM...	ExecutorClass	You should override this class type on the CDO of the object with your Python type when Python is initialized.
	UMoviePipelineQ...	PipelineQueue

Constructors

	Name	Description
	UMoviePipelinePythonHostExecutor()

Functions

	Name	Description
void	ExecuteDelayed ( UMoviePipelineQueue* InPipelin... )	Python/Blueprint API.
void	ExecuteDelayed_Implementation ( UMoviePipelineQueue* InPipelin... )
UWorld *	GetLastLoadedWorld()
void	OnMapLoad ( UWorld* InWorld )
void	OnMapLoad_Implementation ( UWorld* InWorld )

Overridden from UMoviePipelineExecutorBase

	Name	Description
void	CancelAllJobs_Implementation()	You should override this method to implement canceling jobs.
void	CancelCurrentJob_Implementation()	You only need to override this methond if your executor supports multiple queued jobs.
void	Execute_Implementation ( UMoviePipelineQueue* InPipelin... )
bool	IsRendering_Implementation()

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

Take our survey

Dismiss