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(property_name) bool or None ¶
Gets the bool value of the specified property. Returns true on success, else false.
- get_value_byte(property_name) uint8 or None ¶
Gets the byte value of the specified property. Returns true on success, else false.
- Parameters:
property_name (Name) –
- Returns:
out_value (uint8):
- Return type:
uint8 or None
- get_value_class(property_name, out_value) bool ¶
Gets the UClass value of the specified property. Returns true on success, else false.
- get_value_container_type(property_name) MovieGraphContainerType ¶
Gets the container type of the stored value in the specified property.
- Parameters:
property_name (Name) –
- Return type:
- get_value_double(property_name) double or None ¶
Gets the double value of the specified property. Returns true on success, else false.
- Parameters:
property_name (Name) –
- Returns:
out_value (double):
- Return type:
double or None
- get_value_enum(property_name, requested_enum=None) uint8 or None ¶
Gets the enum value (for a specific enum) of the specified property. Returns true on success, else false.
- get_value_float(property_name) float or None ¶
Gets the float value of the specified property. Returns true on success, else false.
- get_value_int32(property_name) int32 or None ¶
Gets the int32 value of the specified property. Returns true on success, else false.
- Parameters:
property_name (Name) –
- Returns:
out_value (int32):
- Return type:
int32 or None
- get_value_int64(property_name) int64 or None ¶
Gets the int64 value of the specified property. Returns true on success, else false.
- Parameters:
property_name (Name) –
- Returns:
out_value (int64):
- Return type:
int64 or None
- get_value_name(property_name) Name or None ¶
Gets the FName value of the specified property. Returns true on success, else false.
- get_value_object(property_name, out_value, requested_class=None) bool ¶
Gets the object value (for a specific class) of the specified property. Returns true on success, else false.
- get_value_serialized_string(property_name) str ¶
Gets the serialized string value of the specified property.
- get_value_string(property_name) str or None ¶
Gets the FString value of the specified property. Returns true on success, else false.
- get_value_text(property_name) Text or None ¶
Gets the FText value of the specified property. Returns true on success, else false.
- get_value_type(property_name) MovieGraphValueType ¶
Gets the type of the value stored in the specified property.
- Parameters:
property_name (Name) –
- Return type:
- get_value_type_object(property_name) Object ¶
Gets the object that defines the enum, struct, or class stored in the specified property.
- 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. Calls UpdateGraphVariableOverrides() to ensure that the overrides reflect the specified graph config.
- Parameters:
graph_config (MovieGraphConfig) –
- set_value_bool(property_name, value) bool ¶
Sets the bool value of the specified property. Returns true on success, else false.
- set_value_byte(property_name, value) bool ¶
Sets the byte value of the specified property. Returns true on success, else false.
- set_value_class(property_name, value) bool ¶
Sets the class value of the specified property. Returns true on success, else false.
- set_value_double(property_name, value) bool ¶
Sets the double value of the specified property. Returns true on success, else false.
- set_value_enum(property_name, value, enum) bool ¶
Sets the enum value of the specified property. Returns true on success, else false.
- set_value_float(property_name, value) bool ¶
Sets the float value of the specified property. Returns true on success, else false.
- set_value_int32(property_name, value) bool ¶
Sets the int32 value of the specified property. Returns true on success, else false.
- set_value_int64(property_name, value) bool ¶
Sets the int64 value of the specified property. Returns true on success, else false.
- set_value_name(property_name, value) bool ¶
Sets the FName value of the specified property. Returns true on success, else false.
- set_value_object(property_name, value) bool ¶
Sets the object value of the specified property. Returns true on success, else false.
- set_value_serialized_string(property_name, 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.
- set_value_string(property_name, value) bool ¶
Sets the FString value of the specified property. Returns true on success, else false.
- set_value_text(property_name, value) bool ¶
Sets the FText value of the specified property. Returns true on success, else false.
- 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:
graph_variable (MovieGraphVariable) –
is_enabled (bool) –
- Return type: