1. Epic GamesDeveloper
  3. UMovieJobVariableAssignmentContainer

UMovieJobVariableAssignmentContainer

Holds a group of properties which override variable values on the job's associated graph (if any).

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

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.

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

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UMovieJobVariableAssignmentContainer : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieJobVariableAssignmentContainer()

   MovieJobVariableAssignmentContainer.h  

Constants

Name Type Remarks Include Path
CategoryMetaDataKey FName The metadata key on properties that is associated with the variable's category. MovieJobVariableAssignmentContainer.h
DisplayNameMetaDataKey FName The metadata key on properties that is associated with the variable's display name. MovieJobVariableAssignmentContainer.h
EnableCategoriesMetaDataKey FName The metadata key on property bag properties that allows them to show up grouped in the details panel. MovieJobVariableAssignmentContainer.h
ToolTipMetaDataKey FName The metadata key on properties that is associated with a tooltip value. MovieJobVariableAssignmentContainer.h
VariableGuidMetaDataKey FName The metadata key on properties that is associated with a value which identifies a graph variable (by GUID). MovieJobVariableAssignmentContainer.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
GraphPreset TSoftObjectPtr< UMovieGraphConfig > The graph preset associated with the variable overrides. MovieJobVariableAssignmentContainer.h  
Value FInstancedPropertyBag The properties managed by this object. MovieJobVariableAssignmentContainer.h
  • EditAnywhere
  • Meta=(ShowOnlyInnerProperties, FixedLayout)
  • Category="Value"

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSoftObjectPtr< UMovieGraphConfig > GetGraphConfig()

 Gets the graph that is associated with this container. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Graph"

uint32 GetNumAssignments ()

 Gets the number of variable assignments present in this container. MovieJobVariableAssignmentContainer.h  

bool GetValueBool ( const UMovieGraphVariable* InGraphVariable,
bool& bOutValue
) const

 Gets the bool value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueByte ( const UMovieGraphVariable* InGraphVariable,
uint8& OutValue
) const

 Gets the byte value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueClass ( const UMovieGraphVariable* InGraphVariable,
UClass*& OutValue
) const

 Gets the UClass value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueContainer ( const UMovieGraphVariable* InGraphVariable,
TObjectPtr< UMovieGraphValueContainer >& OutValueContainer
)

 Gets a value container object rather than a strongly-typed value. MovieJobVariableAssignmentContainer.h  

EMovieGraphContainerType GetValueContainerType ( const UMovieGraphVariable* InGraphVariable
) const

 Gets the container type of the stored value in the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueDouble ( const UMovieGraphVariable* InGraphVariable,
double& OutValue
) const

 Gets the double value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueEnum ( const UMovieGraphVariable* InGraphVariable,
uint8& OutValue,
const UEnum* RequestedEnum
) const

 Gets the enum value (for a specific enum) of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueEnum ( const UMovieGraphVariable* InGraphVariable,
T& OutValue
) const

 Gets the enum value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

bool GetValueFloat ( const UMovieGraphVariable* InGraphVariable,
float& OutValue
) const

 Gets the float value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueInt32 ( const UMovieGraphVariable* InGraphVariable,
int32& OutValue
) const

 Gets the int32 value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueInt64 ( const UMovieGraphVariable* InGraphVariable,
int64& OutValue
) const

 Gets the int64 value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueName ( const UMovieGraphVariable* InGraphVariable,
FName& OutValue
) const

 Gets the FName value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueObject ( const UMovieGraphVariable* InGraphVariable,
UObject* OutValue,
const UClass* RequestedClass
) const

 Gets the object value (for a specific class) of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueObject ( const UMovieGraphVariable* InGraphVariable,
T* OutValue
) const

 Gets the object value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

FString GetValueSerializedString ( const UMovieGraphVariable* InGraphVariable
)

 Gets the serialized string value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetValueString ( const UMovieGraphVariable* InGraphVariable,
FString& OutValue
) const

 Gets the FString value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

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

 Gets the struct value (for a specific struct) of the specified property. MovieJobVariableAssignmentContainer.h  

bool GetValueStruct ( const UMovieGraphVariable* InGraphVariable,
T* OutValue
) const

 Gets the struct value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

bool GetValueText ( const UMovieGraphVariable* InGraphVariable,
FText& OutValue
) const

 Gets the FText value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

EMovieGraphValueType GetValueType ( const UMovieGraphVariable* InGraphVariable
) const

 Gets the type of the value stored in the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

const UObject * GetValueTypeObject ( const UMovieGraphVariable* InGraphVariable
) const

 Gets the object that defines the enum, struct, or class stored in the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool GetVariableAssignmentEnableState ( const UMovieGraphVariable* InGraphVariable,
bool& bOutIsEnabled
)

 Gets the enable state of the variable assignment for the provided graph variable. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Graph"

void SetGraphConfig ( const TSoftObjectPtr< UMovieGraphConfig >& InGraphConfig
)

 Sets the graph config associated with the variable assignments. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Graph"

bool SetValueBool ( const UMovieGraphVariable* InGraphVariable,
const bool bInValue
)

 Sets the bool value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueByte ( const UMovieGraphVariable* InGraphVariable,
const uint8 InValue
)

 Sets the byte value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueClass ( const UMovieGraphVariable* InGraphVariable,
UClass* InValue
)

 Sets the class value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueDouble ( const UMovieGraphVariable* InGraphVariable,
const double InValue
)

 Sets the double value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

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

 Sets the enum value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueEnum ( const UMovieGraphVariable* InGraphVariable,
const T InValue
)

 Sets the enum value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

bool SetValueFloat ( const UMovieGraphVariable* InGraphVariable,
const float InValue
)

 Sets the float value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueInt32 ( const UMovieGraphVariable* InGraphVariable,
const int32 InValue
)

 Sets the int32 value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueInt64 ( const UMovieGraphVariable* InGraphVariable,
const int64 InValue
)

 Sets the int64 value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueName ( const UMovieGraphVariable* InGraphVariable,
const FName InValue
)

 Sets the FName value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueObject ( const UMovieGraphVariable* InGraphVariable,
T* InValue
)

 Sets the object value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

bool SetValueObject ( const UMovieGraphVariable* InGraphVariable,
UObject* InValue
)

 Sets the object value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueSerializedString ( const UMovieGraphVariable* InGraphVariable,
const FString& NewValue
)

 Sets the serialized value of this member. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueString ( const UMovieGraphVariable* InGraphVariable,
const FString& InValue
)

 Sets the FString value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetValueStruct ( const UMovieGraphVariable* InGraphVariable,
FConstStructView InValue
)

 Sets the struct value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

bool SetValueStruct ( const UMovieGraphVariable* InGraphVariable,
const T& InValue
)

 Sets the struct value of the specified property. Returns true on success, else false. MovieJobVariableAssignmentContainer.h  

bool SetValueText ( const UMovieGraphVariable* InGraphVariable,
const FText& InValue
)

 Sets the FText value of the specified property. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Value"

bool SetVariableAssignmentEnableState ( const UMovieGraphVariable* InGraphVariable,
bool bIsEnabled
)

 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. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Graph"
Updates the stored variable overrides to reflect the graph preset. MovieJobVariableAssignmentContainer.h
  • BlueprintCallable
  • Category="Graph"

Protected

Name Remarks Include Path Unreal Specifiers

bool AddVariableAssignment ( const UMovieGraphVariable* InGraphVariable
)

 Add a variable assignment for the graph. MovieJobVariableAssignmentContainer.h  

FName ConvertVariableToInternalName ( const UMovieGraphVariable* InGraphVariable
) const

 Given a graph variable, retrieve the hidden internal name used by our actual property bag. MovieJobVariableAssignmentContainer.h  

bool FindOrGenerateVariableOverride ( const UMovieGraphVariable* InGraphVariable,
FPropertyBagPropertyDesc* OutPropDesc,
FPropertyBagPropertyDesc* OutEditConditionPropDesc,
bool bGenerateIfNotExists
)

 Finds a variable assignment for the provided variable, or adds one if one does not already exist (and bAddIfNotExists is set to true). MovieJobVariableAssignmentContainer.h  

bool GenerateVariableOverride ( const UMovieGraphVariable* InGraphVariable,
FPropertyBagPropertyDesc* OutPropDesc,
FPropertyBagPropertyDesc* OutEditConditionPropDesc
)

 Generates a variable override for the provided variable, as well as the associated EditCondition for it. MovieJobVariableAssignmentContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page