Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
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).
| Name | UMoviePipelinePythonHostExecutor |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelinePythonHostExecutor.h |
| Include Path | #include "MoviePipelinePythonHostExecutor.h" |
Syntax
UCLASS (Blueprintable)
class UMoviePipelinePythonHostExecutor : public UMoviePipelineExecutorBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineExecutorBase → UMoviePipelinePythonHostExecutor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelinePythonHostExecutor() |
MoviePipelinePythonHostExecutor.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExecutorClass | TSubclassOf< UMoviePipelinePythonHostExecutor > | You should override this class type on the CDO of the object with your Python type when Python is initialized. | MoviePipelinePythonHostExecutor.h |
|
| PipelineQueue | TObjectPtr< UMoviePipelineQueue > | MoviePipelinePythonHostExecutor.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastLoadedWorld | TObjectPtr< UWorld > | MoviePipelinePythonHostExecutor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteDelayed
(
UMoviePipelineQueue* InPipelineQueue |
Python/Blueprint API. | MoviePipelinePythonHostExecutor.h |
|
virtual void ExecuteDelayed_Implementation
(
UMoviePipelineQueue* InPipelineQueue |
MoviePipelinePythonHostExecutor.h |
|
|
UWorld * GetLastLoadedWorld() |
MoviePipelinePythonHostExecutor.h |
|
|
void OnMapLoad
(
UWorld* InWorld |
MoviePipelinePythonHostExecutor.h |
|
|
virtual void OnMapLoad_Implementation
(
UWorld* InWorld |
MoviePipelinePythonHostExecutor.h |
|
Overridden from UMoviePipelineExecutorBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CancelAllJobs_Implementation() |
You should override this method to implement canceling jobs. | MoviePipelinePythonHostExecutor.h | |
virtual void CancelCurrentJob_Implementation() |
You only need to override this methond if your executor supports multiple queued jobs. | MoviePipelinePythonHostExecutor.h | |
virtual void Execute_Implementation
(
UMoviePipelineQueue* InPipelineQueue |
MoviePipelinePythonHostExecutor.h | ||
virtual bool IsRendering_Implementation() |
MoviePipelinePythonHostExecutor.h |