unreal.MoviePipelineInProcessExecutor¶
- class unreal.MoviePipelineInProcessExecutor(outer=None, name='None')¶
Bases:
unreal.MoviePipelineLinearExecutorBaseThis executor implementation can process an array of movie pipelines and run them inside the currently running process. This is intended for usage outside of the editor (ie. -game mode) as it will take over the currently running world/game instance instead of launching a new world instance like the editor only PIE.
C++ Source:
Plugin: MovieRenderPipeline
Module: MovieRenderPipelineCore
File: MoviePipelineInProcessExecutor.h
Editor Properties: (see get_editor_property/set_editor_property)
debug_widget_class(type(Class)): [Read-Write] Debug Widget Class: Optional widget for feedback during renderhttp_response_recieved_delegate(MoviePipelineHttpResponseRecieved): [Read-Write] HTTPResponse Recieved Delegate: If an HTTP Request has been made and a response returned, the returned response will be broadcast on this event.on_executor_errored_delegate(OnMoviePipelineExecutorErrored): [Read-Write] On Executor Errored Delegate: Called when an individual job reports a warning/error. Jobs are considered fatal if the severity was bad enough to abort the job (missing sequence, write failure, etc.)Exposed for Blueprints/Python. Called at the same time as the native one.
on_executor_finished_delegate(OnMoviePipelineExecutorFinished): [Read-Write] On Executor Finished Delegate: Called when the Executor has finished all jobs. Reports success if no jobs had fatal errors. Subscribe to the error delegate for more information about any errors.Exposed for Blueprints/Python. Called at the same time as the native one.
socket_message_recieved_delegate(MoviePipelineSocketMessageRecieved): [Read-Write] Socket Message Recieved Delegate: If this executor has been configured to connect to a socket, this event will be called each time the socket recieves something. The message response expected from the server should have a 4 byte (int32) size prefix for the string to specify how much data we should expect. This delegate will not get invoked until we recieve that many bytes from the socket connection to avoid broadcasting partial messages.target_pipeline_class(type(Class)): [Read-Write] Target Pipeline Class: Which Pipeline Class should be created by this Executor. May be null.use_current_level(bool): [Read-Write] Use Current Level: Use current level instead of opening new leveluser_data(str): [Read-Write] User Data: Arbitrary data that can be associated with the executor. Not used by default implementations, nor read. This can be used to attach third party metadata such as job ids from remote farms.