Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
This node allows users to run code before and after a movie graph is being executed. Example use cases would be to run custom logic that overrides the output directory, or to trigger an event after a shot finishes. These bits of script can be implemented in either C++, or in Python (as a UClass) because we don't serialize the object and only create it at runtime during the render. See UMovieGraphScriptBase for details.
| Name | UMovieGraphExecuteScriptNode |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/Nodes/MovieGraphExecuteScriptNode.h |
| Include Path | #include "Graph/Nodes/MovieGraphExecuteScriptNode.h" |
Syntax
UCLASS ()
class UMovieGraphExecuteScriptNode : public UMovieGraphSettingNode
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieGraphNode → UMovieGraphSettingNode → UMovieGraphExecuteScriptNode
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieGraphExecuteScriptNode() |
Graph/Nodes/MovieGraphExecuteScriptNode.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOverride_Script | uint8 | Graph/Nodes/MovieGraphExecuteScriptNode.h |
|
|
| Script | FSoftClassPath | Which script should this node instantiate? The class will be instantiated when the job starts, and then different functions will be called on that instance throughout the life-time of the movie render. | Graph/Nodes/MovieGraphExecuteScriptNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieGraphScriptBase * AllocateScriptInstance() |
Allocate an instance of the specifed script type. Can return nullptr. | Graph/Nodes/MovieGraphExecuteScriptNode.h |
Overridden from UMovieGraphSettingNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateTelemetry
(
FMoviePipelineShotRenderTelemetry* InTelemetry |
Updates telemetry data for this node. | Graph/Nodes/MovieGraphExecuteScriptNode.h |
Overridden from UMovieGraphNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMovieGraphBranchRestriction GetBranchRestriction() |
Determines which types of branches the node can be created in. | Graph/Nodes/MovieGraphExecuteScriptNode.h | |
virtual FSlateIcon GetIconAndTint
(
FLinearColor& OutColor |
Gets the node's icon and icon tint, as visible in the graph. | Graph/Nodes/MovieGraphExecuteScriptNode.h | |
virtual FText GetMenuCategory() |
Gets the category that the node belongs under. | Graph/Nodes/MovieGraphExecuteScriptNode.h | |
virtual FText GetNodeTitle
(
const bool bGetDescriptive |
Gets the node's title. | Graph/Nodes/MovieGraphExecuteScriptNode.h | |
virtual FLinearColor GetNodeTitleColor() |
Gets the node's title color, as visible in the graph. | Graph/Nodes/MovieGraphExecuteScriptNode.h |