unreal.MovieGraphVariable

class unreal.MovieGraphVariable(outer: Object | None = None, name: Name | str = 'None')

Bases: MovieGraphMember

A variable that can be used inside the graph. Most variables are created by the user, and can have their value changed at the job level. Global variables, however, are not user-created and their values are provided when the graph is evaluated. Overriding them at the job level is not possible.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • description (str): [Read-Write] The optional description of this member, which is user-facing.

  • value (InstancedPropertyBag): [Read-Write] The value held by this object.

get_category() → str

Gets the category (if any) assigned to this variable.

Return type:

str

is_global() → bool

Returns true if this variable is a global variable.

Return type:

bool

set_category(new_category) → None

Sets the variable to the provided category. Be aware that the category provided here may not be the final category set on the variable (InNewCategory will be put through FName::NameToDisplayString().

Parameters:

new_category (str)