unreal.MovieJobVariableAssignmentContainer

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

Bases: Object

Holds a group of properties which override variable values on the job’s associated graph (if any). Overrides are not added manually. Instead, UpdateGraphVariableOverrides() should be called which will update, add, or remove overrides as appropriate. After the update, overrides can have their values retrieved and set.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieJobVariableAssignmentContainer.h

Editor Properties: (see get_editor_property/set_editor_property)

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

get_value_bool(graph_variable) → bool or None

Gets the bool value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (bool):

Return type:

bool or None

get_value_byte(graph_variable) → uint8 or None

Gets the byte value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (uint8):

Return type:

uint8 or None

get_value_class(graph_variable) → type(Class) or None

Gets the UClass value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (type(Class)):

Return type:

type(Class) or None

get_value_container_type(graph_variable) → MovieGraphContainerType

Gets the container type of the stored value in the specified property.

Parameters:

graph_variable (MovieGraphVariable) –

Return type:

MovieGraphContainerType

get_value_double(graph_variable) → double or None

Gets the double value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (double):

Return type:

double or None

get_value_enum(graph_variable, requested_enum=None) → uint8 or None

Gets the enum value (for a specific enum) of the specified property. Returns true on success, else false.

Parameters:
Returns:

out_value (uint8):

Return type:

uint8 or None

get_value_float(graph_variable) → float or None

Gets the float value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (float):

Return type:

float or None

get_value_int32(graph_variable) → int32 or None

Gets the int32 value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (int32):

Return type:

int32 or None

get_value_int64(graph_variable) → int64 or None

Gets the int64 value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (int64):

Return type:

int64 or None

get_value_name(graph_variable) → Name or None

Gets the FName value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (Name):

Return type:

Name or None

get_value_object(graph_variable, out_value, requested_class=None) → bool

Gets the object value (for a specific class) of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

get_value_serialized_string(graph_variable) → str

Gets the serialized string value of the specified property.

Parameters:

graph_variable (MovieGraphVariable) –

Return type:

str

get_value_string(graph_variable) → str or None

Gets the FString value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (str):

Return type:

str or None

get_value_text(graph_variable) → Text or None

Gets the FText value of the specified property. Returns true on success, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_value (Text):

Return type:

Text or None

get_value_type(graph_variable) → MovieGraphValueType

Gets the type of the value stored in the specified property.

Parameters:

graph_variable (MovieGraphVariable) –

Return type:

MovieGraphValueType

get_value_type_object(graph_variable) → Object

Gets the object that defines the enum, struct, or class stored in the specified property.

Parameters:

graph_variable (MovieGraphVariable) –

Return type:

Object

get_variable_assignment_enable_state(graph_variable) → bool or None

Gets the enable state of the variable assignment for the provided graph variable. The enable state is provided via bOutIsEnabled. Returns true if an enable state was set on the variable and bOutIsEnabled was changed, else false.

Parameters:

graph_variable (MovieGraphVariable) –

Returns:

out_is_enabled (bool):

Return type:

bool or None

set_graph_config(graph_config) → None

Sets the graph config associated with the variable assignments.

Parameters:

graph_config (MovieGraphConfig) –

set_value_bool(graph_variable, value) → bool

Sets the bool value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_byte(graph_variable, value) → bool

Sets the byte value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_class(graph_variable, value) → bool

Sets the class value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_double(graph_variable, value) → bool

Sets the double value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_enum(graph_variable, value, enum) → bool

Sets the enum value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_float(graph_variable, value) → bool

Sets the float value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_int32(graph_variable, value) → bool

Sets the int32 value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_int64(graph_variable, value) → bool

Sets the int64 value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_name(graph_variable, value) → bool

Sets the FName value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_object(graph_variable, value) → bool

Sets the object value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_serialized_string(graph_variable, new_value) → bool

Sets the serialized value of this member. The string should be the serialized representation of the value. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_string(graph_variable, value) → bool

Sets the FString value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_text(graph_variable, value) → bool

Sets the FText value of the specified property. Returns true on success, else false.

Parameters:
Return type:

bool

set_variable_assignment_enable_state(graph_variable, is_enabled) → bool

Updates an existing variable assignment for the provided graph variable to a new enable state, or adds a new assignment and updates its enable state. Returns true on success, else false.

Parameters:
Return type:

bool

update_graph_variable_overrides() → None

Updates the stored variable overrides to reflect the graph preset. Existing overrides will be updated to match the graph variable name, value type, object type, and container type. Additionally, stale overrides that have no corresponding graph variable will be removed, and overrides will be created for graph variables which do not have existing overrides.