UMovieGraphValueContainer

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

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

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

For a container that holds multiple values, see UMovieGraphMultiValueContainer.

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

Syntax

UCLASS (MinimalAPI)  
class UMovieGraphValueContainer : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphValueContainer()

   Graph/MovieGraphValueContainer.h  

Constants

Name Type Remarks Include Path
PropertyBagDefaultPropertyName const FName The default name of the single property stored in the property bag. Graph/MovieGraphValueContainer.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
MultiValueContainer TObjectPtr< UMovieGraphMultiValueContainer > The container that holds the single value. Graph/MovieGraphValueContainer.h
  • EditAnywhere
  • Instanced
  • Category="Value"
PropertyName FName The name of the single property stored in the property bag. Graph/MovieGraphValueContainer.h  
Value FInstancedPropertyBag UNUSED (kept for backwards compatibility purposes in PostLoad()). The value held by this object. Graph/MovieGraphValueContainer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Gets a reference to the array backing the value, if any. Graph/MovieGraphValueContainer.h  

FName GetPropertyName()

 Gets the name of the property that the value container holds. Graph/MovieGraphValueContainer.h  

bool GetValueBool ( bool& bOutValue
) const

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

bool GetValueByte ( uint8& OutValue
) const

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

bool GetValueClass ( UClass*& OutValue
) const

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

EMovieGraphContainerType GetValueContainerType()

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

bool GetValueDouble ( double& OutValue
) const

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

bool GetValueEnum ( 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/MovieGraphValueContainer.h
  • BlueprintCallable
  • Category="Config"

bool GetValueEnum ( T& OutValue
) const

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

bool GetValueFloat ( float& OutValue
) const

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

bool GetValueInt32 ( int32& OutValue
) const

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

bool GetValueInt64 ( int64& OutValue
) const

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

bool GetValueName ( FName& OutValue
) const

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

bool GetValueObject ( T*& OutValue
) const

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

bool GetValueObject ( 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/MovieGraphValueContainer.h
  • BlueprintCallable
  • Category="Config"

FString GetValueSerializedString()

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

bool GetValueString ( FString& OutValue
) const

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

bool GetValueStruct ( T*& OutValue
) const

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

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

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

bool GetValueText ( FText& OutValue
) const

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

EMovieGraphValueType GetValueType()

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

const UObject * GetValueTypeObject()

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

void SetPropertyName ( const FName& InName
)

 Sets the name of the property that the value container holds. Graph/MovieGraphValueContainer.h  

bool SetValueBool ( const bool bInValue
)

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

bool SetValueByte ( const uint8 InValue
)

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

bool SetValueClass ( UClass* InValue
)

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

void SetValueContainerType ( EMovieGraphContainerType ContainerType
)

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

bool SetValueDouble ( const double InValue
)

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

bool SetValueEnum ( const uint8 InValue,
const UEnum* Enum
)

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

bool SetValueEnum ( const T InValue
)

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

bool SetValueFloat ( const float InValue
)

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

bool SetValueInt32 ( const int32 InValue
)

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

bool SetValueInt64 ( const int64 InValue
)

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

bool SetValueName ( const FName InValue
)

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

bool SetValueObject ( T* InValue
)

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

bool SetValueObject ( UObject* InValue
)

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

bool SetValueSerializedString ( const FString& NewValue
)

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

bool SetValueString ( const FString& InValue
)

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

bool SetValueStruct ( FConstStructView InValue
)

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

bool SetValueStruct ( const T& InValue
)

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

bool SetValueText ( const FText& InValue
)

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

void SetValueType ( EMovieGraphValueType ValueType,
UObject* InValueTypeObject
)

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

void SetValueTypeObject ( const UObject* ValueTypeObject
)

 Sets the object that defines the enum, struct, or class. Graph/MovieGraphValueContainer.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