FRigVMStructUpgradeInfo | Unreal Engine 5.7 Documentation

Structure used to upgrade to a new implementation of a node


Name	FRigVMStructUpgradeInfo
Type	struct
Header File	/Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMStructUpgradeInfo.h
Include Path	#include "RigVMCore/RigVMStructUpgradeInfo.h"

Syntax

struct FRigVMStructUpgradeInfo

Name	Remarks	Include Path	Unreal Specifiers
FRigVMStructUpgradeInfo ()		RigVMCore/RigVMStructUpgradeInfo.h
FRigVMStructUpgradeInfo ( const Old& InOld, const New& InNew )		RigVMCore/RigVMStructUpgradeInfo.h
FRigVMStructUpgradeInfo ( UScriptStruct* InOldDispatchStruct, UScriptStruct* InNewDispatchStruct, const FName& InOldDispatchFunction, const FName& InNewDispatchFunction )		RigVMCore/RigVMStructUpgradeInfo.h

Name	Type	Remarks	Include Path
AggregatePins	TArray< FString >	Aggregate pins to add.	RigVMCore/RigVMStructUpgradeInfo.h
DefaultValues	TMap< FName, FString >	New sets of default values.	RigVMCore/RigVMStructUpgradeInfo.h
InputLinkMap	TMap< FString, FString >	Remapping info for re-linking inputs Entries can be root pins or sub pins	RigVMCore/RigVMStructUpgradeInfo.h
NewDispatchFunction	FName	The new optional function name this upgrade info is targeting.	RigVMCore/RigVMStructUpgradeInfo.h
NewStruct	UScriptStruct *	The new struct this upgrade info is targeting.	RigVMCore/RigVMStructUpgradeInfo.h
NodePath	FString	The complete node path including models / collapse node.	RigVMCore/RigVMStructUpgradeInfo.h
OldDispatchFunction	FName	The old optional function name this upgrade info originates from.	RigVMCore/RigVMStructUpgradeInfo.h
OldStruct	UScriptStruct *	The old struct this upgrade info originates from.	RigVMCore/RigVMStructUpgradeInfo.h
OutputLinkMap	TMap< FString, FString >	Remapping info for re-linking outputs Entries can be root pins or sub pins	RigVMCore/RigVMStructUpgradeInfo.h

Name	Remarks	Include Path
FString AddAggregatePin ( FString InPinName )	Adds a new aggregate pin	RigVMCore/RigVMStructUpgradeInfo.h
void AddRemappedPin ( const FString& InOldPinPath, const FString& InNewPinPath, bool bAsInput, bool bAsOutput )	Adds a pin to be remapped	RigVMCore/RigVMStructUpgradeInfo.h
const TArray< FString > & GetAggregatePins()	Returns the aggregate pins to add	RigVMCore/RigVMStructUpgradeInfo.h
const FString & GetDefaultValueForPin ( const FName& InPinName ) const	Returns the default value for a given pin	RigVMCore/RigVMStructUpgradeInfo.h
const TMap< FName, FString > & GetDefaultValues()	Returns the map for all default values	RigVMCore/RigVMStructUpgradeInfo.h
UScriptStruct * GetNewStruct()	Returns the new struct to upgrade to	RigVMCore/RigVMStructUpgradeInfo.h
UScriptStruct * GetOldStruct()	Returns the old struct trying to be upgraded	RigVMCore/RigVMStructUpgradeInfo.h
bool IsValid()	Returns true if this upgrade info can be applied	RigVMCore/RigVMStructUpgradeInfo.h
FString RemapPin ( const FString& InPinPath, bool bIsInput, bool bContainsNodeName ) const	Remaps a pin path based on our internals	RigVMCore/RigVMStructUpgradeInfo.h
void SetDefaultValueForPin ( const FName& InPinName, const FString& InDefaultValue )	Sets the default value for a given pin	RigVMCore/RigVMStructUpgradeInfo.h

Name	Remarks	Include Path	Unreal Specifiers
static FRigVMTemplateTypeMap GetTypeMapFromStruct ( UScriptStruct* InScriptStruct )	Returns a type map representing the struct members	RigVMCore/RigVMStructUpgradeInfo.h
static FRigVMStructUpgradeInfo MakeFromStructToFactory ( UScriptStruct* InRigVMStruct, UScriptStruct* InFactoryStruct, const TMap< FName, FName >& InArgumentNameMap )		RigVMCore/RigVMStructUpgradeInfo.h