unreal.MovieGraphMultiValueContainer

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

Bases: Object

Holds generic values, with an API for getting/setting values, as well as getting/setting the value types and value container types (eg, array).

For a container that holds a single value, see UMovieGraphValueContainer.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphMultiValueContainer.h

Editor Properties: (see get_editor_property/set_editor_property)

  • values (InstancedPropertyBag): [Read-Write] The values held by this container.

add_property(property_name, value_type, value_type_object, metadata) → bool

Adds a new property to the container. If a property by the given name already exists, no add operation will occur. Returns true on successful add, otherwise returns false.

Parameters:
Return type:

bool

get_num_properties() → int32

Gets the number of properties that this container holds.

Return type:

int32

get_property_metadata(property_name) → Map[Name, str]

Gets the metadata for the given property.

Parameters:

property_name (Name)

Return type:

Map[Name, str]

get_property_names() → Array[Name]

Gets the names of properties in this container.

Return type:

Array[Name]

get_value_bool(property_name) → bool or None

Gets the bool value of the held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (bool):

Return type:

bool or None

get_value_byte(property_name) → uint8 or None

Gets the byte value of the held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (uint8):

Return type:

uint8 or None

get_value_class(property_name) → type(Class) or None

Gets the UClass value of the held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (type(Class)):

Return type:

type(Class) or None

get_value_container_type(property_name) → MovieGraphContainerType

Gets the container type of the stored value.

Parameters:

property_name (Name)

Return type:

MovieGraphContainerType

get_value_double(property_name) → double or None

Gets the double value of the held data. 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 held data. Returns true on success, else false.

Parameters:

  • property_name (Name)

  • requested_enum (Enum)

Returns:

out_value (uint8):

Return type:

uint8 or None

get_value_float(property_name) → float or None

Gets the float value of the held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (float):

Return type:

float or None

get_value_int32(property_name) → int32 or None

Gets the int32 value of the held data. 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 held data. 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 held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (Name):

Return type:

Name or None

get_value_object(property_name, requested_class=None) → Object or None

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

Parameters:
Returns:

out_value (Object):

Return type:

Object or None

get_value_serialized_string(property_name) → str

Gets the serialized string value of the held data.

Parameters:

property_name (Name)

Return type:

str

get_value_string(property_name) → str or None

Gets the FString value of the held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (str):

Return type:

str or None

get_value_text(property_name) → Text or None

Gets the FText value of the held data. Returns true on success, else false.

Parameters:

property_name (Name)

Returns:

out_value (Text):

Return type:

Text or None

get_value_type(property_name) → MovieGraphValueType

Gets the type of the stored data.

Parameters:

property_name (Name)

Return type:

MovieGraphValueType

get_value_type_object(property_name) → Object

Gets the object that defines the enum, struct, or class.

Parameters:

property_name (Name)

Return type:

Object

has_property(property_name) → bool

Returns true if a property by the given name exists in the container, else false.

Parameters:

property_name (Name)

Return type:

bool

remove_property(property_name) → bool

Removes a property by the given name. Returns true on successful remove, otherwise returns false.

Parameters:

property_name (Name)

Return type:

bool

set_value_bool(property_name, value) → bool

Sets the bool value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_byte(property_name, value) → bool

Sets the byte value of the held data. Returns true on success, else false.

Parameters:

  • property_name (Name)

  • value (uint8)

Return type:

bool

set_value_class(property_name, value) → bool

Sets the class value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_container_type(property_name, container_type) → None

Sets the container type of the stored value.

Parameters:
set_value_double(property_name, value) → bool

Sets the double value of the held data. Returns true on success, else false.

Parameters:

  • property_name (Name)

  • value (double)

Return type:

bool

set_value_enum(property_name, value, enum) → bool

Sets the enum value of the held data. Returns true on success, else false.

Parameters:

  • property_name (Name)

  • value (uint8)

  • enum (Enum)

Return type:

bool

set_value_float(property_name, value) → bool

Sets the float value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_int32(property_name, value) → bool

Sets the int32 value of the held data. Returns true on success, else false.

Parameters:

  • property_name (Name)

  • value (int32)

Return type:

bool

set_value_int64(property_name, value) → bool

Sets the int64 value of the held data. Returns true on success, else false.

Parameters:

  • property_name (Name)

  • value (int64)

Return type:

bool

set_value_name(property_name, value) → bool

Sets the FName value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_object(property_name, value) → bool

Sets the object value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_serialized_string(property_name, new_value) → bool

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

Parameters:

  • property_name (Name)

  • new_value (str)

Return type:

bool

set_value_string(property_name, value) → bool

Sets the FString value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_text(property_name, value) → bool

Sets the FText value of the held data. Returns true on success, else false.

Parameters:
Return type:

bool

set_value_type(property_name, value_type, value_type_object=None) → None

Sets the type of the stored data. Enums, structs, and classes must specify a value type object.

Parameters:
set_value_type_object(property_name, value_type_object) → None

Sets the object that defines the enum, struct, or class.

Parameters: