UMovieGraphMultiValueContainer

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

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

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.

   
Name UMovieGraphMultiValueContainer
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphMultiValueContainer.h
Include Path #include "Graph/MovieGraphMultiValueContainer.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieGraphMultiValueContainer : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphMultiValueContainer()

   Graph/MovieGraphMultiValueContainer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Values FInstancedPropertyBag Using a property bag solves a number of issues that would be very difficult to solve otherwise. Graph/MovieGraphMultiValueContainer.h
  • EditAnywhere
  • Meta=(ShowOnlyInnerProperties, FixedLayout)
  • Category="Value"
ValuesView TObjectPtr< UMovieGraphMutableValueView >   Graph/MovieGraphMultiValueContainer.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddProperty ( const FName& InPropertyName,
const EMovieGraphValueType ValueType,
UObject* InValueTypeObject,
const TMap< FName, FString >& InMetadata
)

 Adds a new property to the container. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"
Gets a reference to the array backing the value, if any. Graph/MovieGraphMultiValueContainer.h  

int32 GetNumProperties()

 Gets the number of properties that this container holds. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

TMap< FName, FString > GetPropertyMetadata ( const FName& InPropertyName
) const

 Gets the metadata for the given property. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

TArray< FName > GetPropertyNames()

 Gets the names of properties in this container. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueBool ( const FName& InPropertyName,
bool& bOutValue
) const

 Gets the bool value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueByte ( const FName& InPropertyName,
uint8& OutValue
) const

 Gets the byte value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueClass ( const FName& InPropertyName,
UClass*& OutValue
) const

 Gets the UClass value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

EMovieGraphContainerType GetValueContainerType ( const FName& InPropertyName
) const

 Gets the container type of the stored value. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueDouble ( const FName& InPropertyName,
double& OutValue
) const

 Gets the double value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueEnum ( const FName& InPropertyName,
uint8& OutValue,
const UEnum* RequestedEnum
) const

 Gets the enum value (for a specific enum) of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueEnum ( const FName& InPropertyName,
T& OutValue
) const

 Gets the enum value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool GetValueFloat ( const FName& InPropertyName,
float& OutValue
) const

 Gets the float value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueInt32 ( const FName& InPropertyName,
int32& OutValue
) const

 Gets the int32 value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueInt64 ( const FName& InPropertyName,
int64& OutValue
) const

 Gets the int64 value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueName ( const FName& InPropertyName,
FName& OutValue
) const

 Gets the FName value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueObject ( const FName& InPropertyName,
T*& OutValue
) const

 Gets the object value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool GetValueObject ( const FName& InPropertyName,
UObject*& OutValue,
const UClass* RequestedClass
) const

 Gets the object value (for a specific class) of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

FString GetValueSerializedString ( const FName& InPropertyName
)

 Gets the serialized string value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueString ( const FName& InPropertyName,
FString& OutValue
) const

 Gets the FString value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueStruct ( const FName& InPropertyName,
FStructView& OutValue,
const UScriptStruct* RequestedStruct
) const

 Gets the struct value (for a specific struct) of the held data. Graph/MovieGraphMultiValueContainer.h  

bool GetValueStruct ( const FName& InPropertyName,
T*& OutValue
) const

 Gets the struct value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool GetValueText ( const FName& InPropertyName,
FText& OutValue
) const

 Gets the FText value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

EMovieGraphValueType GetValueType ( const FName& InPropertyName
) const

 Gets the type of the stored data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

const UObject * GetValueTypeObject ( const FName& InPropertyName
) const

 Gets the object that defines the enum, struct, or class. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool HasProperty ( const FName& InPropertyName
)

 Returns true if a property by the given name exists in the container, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool RemoveProperty ( const FName& InPropertyName
)

 Removes a property by the given name. Returns true on successful remove, otherwise returns false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueBool ( const FName& InPropertyName,
const bool bInValue
)

 Sets the bool value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueByte ( const FName& InPropertyName,
const uint8 InValue
)

 Sets the byte value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueClass ( const FName& InPropertyName,
UClass* InValue
)

 Sets the class value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

void SetValueContainerType ( const FName& InPropertyName,
EMovieGraphContainerType ContainerType
)

 Sets the container type of the stored value. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueDouble ( const FName& InPropertyName,
const double InValue
)

 Sets the double value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueEnum ( const FName& InPropertyName,
const uint8 InValue,
const UEnum* Enum
)

 Sets the enum value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueEnum ( const FName& InPropertyName,
const T InValue
)

 Sets the enum value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool SetValueFloat ( const FName& InPropertyName,
const float InValue
)

 Sets the float value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueInt32 ( const FName& InPropertyName,
const int32 InValue
)

 Sets the int32 value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueInt64 ( const FName& InPropertyName,
const int64 InValue
)

 Sets the int64 value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueName ( const FName& InPropertyName,
const FName InValue
)

 Sets the FName value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueObject ( const FName& InPropertyName,
T* InValue
)

 Sets the object value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool SetValueObject ( const FName& InPropertyName,
UObject* InValue
)

 Sets the object value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueSerializedString ( const FName& InPropertyName,
const FString& NewValue
)

 Sets the serialized value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueString ( const FName& InPropertyName,
const FString& InValue
)

 Sets the FString value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool SetValueStruct ( const FName& InPropertyName,
FConstStructView InValue
)

 Sets the struct value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool SetValueStruct ( const FName& InPropertyName,
const T& InValue
)

 Sets the struct value of the held data. Returns true on success, else false. Graph/MovieGraphMultiValueContainer.h  

bool SetValueText ( const FName& InPropertyName,
const FText& InValue
)

 Sets the FText value of the held data. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

void SetValueType ( const FName& InPropertyName,
EMovieGraphValueType ValueType,
UObject* InValueTypeObject
)

 Sets the type of the stored data. Enums, structs, and classes must specify a value type object. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

void SetValueTypeObject ( const FName& InPropertyName,
const UObject* ValueTypeObject
)

 Sets the object that defines the enum, struct, or class. Graph/MovieGraphMultiValueContainer.h
  • BlueprintCallable
  • Category="Config"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page