unreal.MovieGraphValueContainer

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

Bases: Object

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

C++ Source:

• Plugin: MovieRenderPipeline

• Module: MovieRenderPipelineCore

• File: MovieGraphValueContainer.h

Editor Properties: (see get_editor_property/set_editor_property)

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

get_value_bool() → bool or None

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

Returns:

out_value (bool):

Return type:

bool or None

get_value_byte() → uint8 or None

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

Returns:

out_value (uint8):

Return type:

uint8 or None

get_value_class() → type(Class) or None

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

Returns:

out_value (type(Class)):

Return type:

type(Class) or None

get_value_container_type() → MovieGraphContainerType

Gets the container type of the stored value.

Return type:

MovieGraphContainerType

get_value_double() → double or None

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

Returns:

out_value (double):

Return type:

double or None

get_value_enum(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:

requested_enum (Enum) –

Returns:

out_value (uint8):

Return type:

uint8 or None

get_value_float() → float or None

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

Returns:

out_value (float):

Return type:

float or None

get_value_int32() → int32 or None

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

Returns:

out_value (int32):

Return type:

int32 or None

get_value_int64() → int64 or None

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

Returns:

out_value (int64):

Return type:

int64 or None

get_value_name() → Name or None

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

Returns:

out_value (Name):

Return type:

Name or None

get_value_object(out_value, requested_class=None) → bool

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

Parameters:

• out_value (Object) –

• requested_class (type(Class)) –

Return type:

bool

get_value_serialized_string() → str

Gets the serialized string value of the held data.

Return type:

str

get_value_string() → str or None

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

Returns:

out_value (str):

Return type:

str or None

get_value_text() → Text or None

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

Returns:

out_value (Text):

Return type:

Text or None

get_value_type() → MovieGraphValueType

Gets the type of the stored data.

Return type:

MovieGraphValueType

get_value_type_object() → Object

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

Return type:

Object

set_value_bool(value) → bool

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

Parameters:

value (bool) –

Return type:

bool

set_value_byte(value) → bool

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

Parameters:

value (uint8) –

Return type:

bool

set_value_class(value) → bool

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

Parameters:

value (type(Class)) –

Return type:

bool

set_value_container_type(container_type) → None

Sets the container type of the stored value.

Parameters:

container_type (MovieGraphContainerType) –

set_value_double(value) → bool

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

Parameters:

value (double) –

Return type:

bool

set_value_enum(value, enum) → bool

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

Parameters:

• value (uint8) –

• enum (Enum) –

Return type:

bool

set_value_float(value) → bool

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

Parameters:

value (float) –

Return type:

bool

set_value_int32(value) → bool

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

Parameters:

value (int32) –

Return type:

bool

set_value_int64(value) → bool

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

Parameters:

value (int64) –

Return type:

bool

set_value_name(value) → bool

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

Parameters:

value (Name) –

Return type:

bool

set_value_object(value) → bool

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

Parameters:

value (Object) –

Return type:

bool

set_value_serialized_string(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:

new_value (str) –

Return type:

bool

set_value_string(value) → bool

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

Parameters:

value (str) –

Return type:

bool

set_value_text(value) → bool

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

Parameters:

value (Text) –

Return type:

bool

set_value_type(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:

• value_type (MovieGraphValueType) –

• value_type_object (Object) –

set_value_type_object(value_type_object) → None

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

Parameters:

value_type_object (Object) –