1. Epic GamesDeveloper
  3. URigVMBuildData

URigVMBuildData

The Build Data is used to store transient / intermediate build information for the RigVM graph to improve the user experience.

API > API/Plugins > API/Plugins/RigVMDeveloper

The Build Data is used to store transient / intermediate build information for the RigVM graph to improve the user experience. This object is never serialized.

   
Name URigVMBuildData
Type class
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMBuildData.h
Include Path #include "RigVMModel/RigVMBuildData.h"

Syntax

UCLASS (BlueprintType)  
class URigVMBuildData : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URigVMBuildData()

 Disable default constructor RigVMModel/RigVMBuildData.h  

Constants

Name Type Remarks Include Path
bInitialized bool   RigVMModel/RigVMBuildData.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsRunningUnitTest bool   RigVMModel/RigVMBuildData.h  
GraphFunctionReferences TMap< FRigVMGraphFunctionIdentifier, FRigVMFunctionReferenceArray >   RigVMModel/RigVMBuildData.h
  • VisibleAnywhere
  • Category="BuildData"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearInvalidReferences()

 Clear references to temp assets. RigVMModel/RigVMBuildData.h  

FRigVMVariantRef CreateAssetVariant ( const FAssetData& InAssetData,
FName InName
)

 Creates a new variant of an asset. RigVMModel/RigVMBuildData.h
  • BlueprintCallable
  • Category=RigVMBuildData

FRigVMVariantRef CreateFunctionVariant ( const FRigVMGraphFunctionIdentifier& InFunctionIdentifier,
FName InName
)

 Creates a new variant of a graph function within the same asset. RigVMModel/RigVMBuildData.h
  • BlueprintCallable
  • Category=RigVMBuildData

TArray< FRigVMVariantRef > FindAssetVariantRefs ( const FGuid& InGuid
) const

 Will find all the asset variants matching the given variant guid. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

const FRigVMFunctionReferenceArray * FindFunctionReferences ( const FRigVMGraphFunctionIdentifier& InFunction
) const

 Returns the list of references for a given function definition. RigVMModel/RigVMBuildData.h  

TArray< FRigVMVariantRef > FindFunctionVariantRefs ( const FGuid& InGuid
) const

 Will find all the function variants matching the given variant guid. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

void ForEachFunctionReference ( const FRigVMGraphFunctionIdentifier& InFunction,
TFunction< void(URigVMFunctionReferenceNode*)> PerReferenceFunction,
bool bLoadIfNecessary
) const

 Iterator function to invoke a lambda / TFunction for each reference of a function RigVMModel/RigVMBuildData.h  

void ForEachFunctionReferenceSoftPtr ( const FRigVMGraphFunctionIdentifier& InFunction,
TFunction< void(TSoftObjectPtr< URigVMFunctionReferenceNode >)> PerReferenceFunction
) const

 Iterator function to invoke a lambda / TFunction for each reference of a function RigVMModel/RigVMBuildData.h  

TArray< FRigVMVariantRef > GatherAllAssetVariantRefs()

 Will find all asset variant refs. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

TArray< FRigVMVariantRef > GatherAllFunctionVariantRefs()

 Will find all public function variant refs, and private function variant refs from loaded assets. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

TArray< FRigVMVariantRef > GatherFunctionVariantRefsForAsset ( const FAssetData& InAssetData
) const

 Will find the public function variant refs inside this asset, and private function variant refs if the asset is loaded. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

TArray< FRigVMGraphFunctionIdentifier > GetAllFunctionIdentifiers ( bool bOnlyPublic
) const

 Returns all known public function identifiers used in the project. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

FRigVMFunctionReferenceArray GetAllFunctionReferences()

 Returns all known function references. RigVMModel/RigVMBuildData.h  

FAssetData GetAssetDataForPath ( const FSoftObjectPath& InObjectPath
) const

 Returns the asset data given an object path. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

FAssetData GetAssetDataForVariant ( const FRigVMVariantRef& InVariantRef
) const

 Returns the asset data given a variant reference. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

FRigVMGraphFunctionIdentifier GetFunctionIdentifierForVariant ( const FRigVMVariantRef& InVariantRef
) const

 Returns the function identifier given a variant reference. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

TArray< FRigVMGraphFunctionIdentifier > GetUsedFunctionIdentifiers ( bool bOnlyPublic
) const

 Returns all known public function identifiers used in the project. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

FRigVMVariantRef GetVariantRefForAsset ( const FAssetData& InAssetData
) const

 Returns the asset data given a variant reference. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

void InitializeIfNeeded()

 Looks for all function references (in RigVMClientHost metadata) and initializes the URigVMBuildData. RigVMModel/RigVMBuildData.h  

FRigVMVariantRef JoinVariantSet ( const FRigVMVariantRef& InVariantRef,
const FGuid& InGuid
)

 Joins a variant with another variant's set. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData
Registers a new reference node for a given function RigVMModel/RigVMBuildData.h  
Registers a new reference node for a given function RigVMModel/RigVMBuildData.h  

void RegisterFunctionReference ( FRigVMReferenceNodeData InReferenceNodeData
)

 Registers a new reference node for a given function RigVMModel/RigVMBuildData.h  

void SetIsRunningUnitTest ( bool bIsRunning
)

 Helper function to disable clearing transient package references. RigVMModel/RigVMBuildData.h  

FRigVMVariantRef SplitVariantFromSet ( const FRigVMVariantRef& InVariantRef
)

 Splits a variant from its variant set (by assigning a new, unique guid. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData
Unregisters a new reference node for a given function RigVMModel/RigVMBuildData.h  
Unregisters a new reference node for a given function RigVMModel/RigVMBuildData.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< UClass * > FindAllRigVMAssetClasses()

   RigVMModel/RigVMBuildData.h  

static URigVMBuildData * Get()

 Returns the singleton build data. RigVMModel/RigVMBuildData.h
  • BlueprintPure
  • Category=RigVMBuildData

static TArray< FRigVMGraphFunctionHeader > GetFunctionHeadersForAsset ( const FAssetData& InAssetData
)

   RigVMModel/RigVMBuildData.h  

static void RegisterReferencesFromAsset ( const FAssetData& AssetData
)

   RigVMModel/RigVMBuildData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page