unreal.MoviePipelineQueue

class unreal.MoviePipelineQueue(outer=None, name='None')

Bases: unreal.Object

A queue is a list of jobs that have been executed, are executing and are waiting to be executed. These can be saved to specific assets to allow

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MoviePipelineQueue.h

allocate_new_job(job_type)MoviePipelineExecutorJob

Allocates a new Job in this Queue. The Queue owns the jobs for memory management purposes, and this will handle that for you.

Parameters

job_type (type(Class)) – Specify the specific Job type that should be created. Custom Executors can use custom Job types to allow the user to provide more information.

Returns

The created Executor job instance.

Return type

MoviePipelineExecutorJob

copy_from(queue)None

Replace the contents of this queue with a copy of the contents from another queue.

Parameters

queue (MoviePipelineQueue) –

delete_job(job)None

Deletes the specified job from the Queue.

Parameters

job (MoviePipelineExecutorJob) – The job to look for and delete.

duplicate_job(job)MoviePipelineExecutorJob

Duplicate the specific job and return the duplicate. Configurations are duplicated and not shared.

Parameters

job (MoviePipelineExecutorJob) – The job to look for to duplicate.

Returns

The duplicated instance or nullptr if a duplicate could not be made.

Return type

MoviePipelineExecutorJob

get_jobs()

Get all of the Jobs contained in this Queue.

Returns

The jobs contained by this queue.

Return type

Array(MoviePipelineExecutorJob)