URigVMEditorAsset

API > API/Plugins > API/Plugins/RigVMDeveloper

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

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class URigVMEditorAsset :  
    public UObject ,  
    public IRigVMEditorAssetInterface ,  
    public IRigVMClientHost

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  RigVMEditorAsset.h  

URigVMEditorAsset ( const FObjectInitializer& ObjectInitializer
)

   RigVMEditorAsset.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bReferencedObjectPathsStored bool   RigVMEditorAsset.h  
CompileSettings FRigVMCompileSettings   RigVMEditorAsset.h  
CurrentMessageLog TUniquePtr< FCompilerResultsLog > If this asset is currently being compiled, the CurrentMessageLog will be the log currently being used to send logs to. RigVMEditorAsset.h  
DummyOnPostVariableChanged FOnRigVMPostVariablesChanged   RigVMEditorAsset.h  
DummyOnPreVariableChanged FOnRigVMPreVariablesChanged   RigVMEditorAsset.h  
EditorHost TObjectPtr< URigVMHost > Declaring these transient properties here instead of the IRigVMEditorAssetInterface class in order to have them as UPROPERTY, to avoid having stale pointers when GC happens. RigVMEditorAsset.h
  • Transient
FunctionGraphs TArray< TObjectPtr< UEdGraph > > Set of functions implemented for this class graphically RigVMEditorAsset.h
  • Transient
FunctionLibraryEdGraph TObjectPtr< URigVMEdGraph >   RigVMEditorAsset.h
  • Transient
GraphDisplaySettings FRigVMEdGraphDisplaySettings   RigVMEditorAsset.h  
LastEditedDocuments TArray< struct FEditedDocumentInfo > Set of documents that were being edited in this blueprint, so we can open them right away RigVMEditorAsset.h  
ReferencedObjectPaths TArray< FSoftObjectPath >   RigVMEditorAsset.h  
RigVMClient FRigVMClient   RigVMEditorAsset.h  
RootEdGraphs TArray< TObjectPtr< UEdGraph > >   RigVMEditorAsset.h  
WatchedPin TArray< UEdGraphPin * >   RigVMEditorAsset.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DebuggingWorldRegistrationHelper ( UObject* ObjectProvidingWorld,
UObject* ValueToRegister
)

   RigVMEditorAsset.h  

URigVMRuntimeAsset * GetRuntimeAsset()

   RigVMEditorAsset.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual URigVMHost * CreateRigVMHost()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool SetVariableIndex ( const FGuid& InVariableGuid,
int32 NewIndex
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   RigVMEditorAsset.h  

virtual bool IsPostLoadThreadSafe()

   RigVMEditorAsset.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   RigVMEditorAsset.h  

virtual void PostLoad()

   RigVMEditorAsset.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   RigVMEditorAsset.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   RigVMEditorAsset.h  

virtual void PreDuplicate ( FObjectDuplicationParameters& DupParams
)

   RigVMEditorAsset.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   RigVMEditorAsset.h  

virtual void Serialize ( FArchive& Ar
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="Variants"

Overridden from IRigVMEditorAssetInterface

Name Remarks Include Path Unreal Specifiers

virtual FName AddHostMemberVariableFromExternal ( FRigVMExternalVariable InVariableToCreate,
FString InDefaultValue
)

   RigVMEditorAsset.h  

virtual void AddLastEditedDocument ( URigVMEdGraph* RigVMEdGraph
)

   RigVMEditorAsset.h  

virtual FName AddMemberVariable ( const FName& InName,
const FString& InCPPType,
bool bIsPublic,
bool bIsReadOnly,
FString InDefaultValue
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual URigVMGraph * AddModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual void AddPinWatch ( UEdGraphPin* InPin
)

   RigVMEditorAsset.h  

virtual void AddUbergraphPage ( URigVMEdGraph* RigVMEdGraph
)

   RigVMEditorAsset.h  

virtual bool BulkRemoveMemberVariables ( const TArray< FName >& InNames
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool ChangeMemberVariableType ( const FName& InName,
const FString& InCPPType,
bool bIsPublic,
bool bIsReadOnly,
FString InDefaultValue
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool ChangeMemberVariableType ( const FName& InName,
const FEdGraphPinType& InType
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual void ClearPinWatches()

   RigVMEditorAsset.h  

virtual void Compile()

   RigVMEditorAsset.h  

virtual FCompilerResultsLog CompileBlueprint()

   RigVMEditorAsset.h  

virtual URigVMHost * CreateRigVMHostSuper ( UObject* InOuter,
FName InName,
EObjectFlags InFlags
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual void DecrementVMRecompileBracket()

   RigVMEditorAsset.h  

virtual FProperty * FindGeneratedPropertyByName ( const FName& InName
)

   RigVMEditorAsset.h  

virtual void ForeachPinWatch ( TFunctionRef< void(UEdGraphPin*)> Task
)

   RigVMEditorAsset.h  
  RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual TArray< FString > GeneratePythonContextCommands ( const FString InNewBlueprintName,
bool bCreateAsset
)

   RigVMEditorAsset.h  

virtual void GetAllEdGraphs ( TArray< UEdGraph* >& Graphs
) const

   RigVMEditorAsset.h  

virtual TArray< URigVMGraph * > GetAllModels()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual TArray< UObject * > GetArchetypeInstances ( bool bIncludeCDO,
bool bIncludeDerivedClass
) const

   RigVMEditorAsset.h  

virtual UObject * GetAssetObjectForEditor()

   RigVMEditorAsset.h  

virtual void GetAssetRegistryTagsSuper ( FAssetRegistryTagsContext Context
) const

   RigVMEditorAsset.h  

virtual ERigVMAssetStatus GetAssetStatus()

   RigVMEditorAsset.h  

virtual TArray< FRigVMGraphVariableDescription > GetAssetVariables()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual FRigVMVariant & GetAssetVariant()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual FRigVMVariantRef GetAssetVariantRef()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool GetAutoVMRecompile()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual URigVMController * GetController ( const UEdGraph* InGraph
) const

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual URigVMController * GetController ( const URigVMGraph* InGraph
) const

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual URigVMController * GetControllerByName ( const FString InGraphName
) const

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual FCompilerResultsLog * GetCurrentMessageLog()

   RigVMEditorAsset.h  

virtual FRigVMDebugInfo & GetDebugInfo()

   RigVMEditorAsset.h  

virtual URigVMGraph * GetDefaultModel()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual UObject * GetDefaultsObject()

   RigVMEditorAsset.h  

virtual FRigVMDrawContainer & GetDrawContainer()

   RigVMEditorAsset.h  

virtual TObjectPtr< URigVMHost > & GetEditorHost()

 Our currently running rig vm instance RigVMEditorAsset.h  

virtual UObject * GetEditorObjectForRigVMGraph ( const URigVMGraph* InVMGraph
) const

 IRigVMClientHost interface Start RigVMEditorAsset.h  

virtual TArray< FRigVMExternalVariable > GetExternalVariables ( bool bFallbackToBlueprint
) const

   RigVMEditorAsset.h  

virtual URigVMGraph * GetFocusedModel()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual TArray< TObjectPtr< UEdGraph > > & GetFunctionGraphs()

   RigVMEditorAsset.h  

virtual TObjectPtr< URigVMEdGraph > & GetFunctionLibraryEdGraph()

   RigVMEditorAsset.h  

virtual TArray< FRigVMReferenceNodeData > & GetFunctionReferenceNodeData()

   RigVMEditorAsset.h  

virtual TArray< struct FEditedDocumentInfo > & GetLastEditedDocuments()

   RigVMEditorAsset.h  

virtual URigVMFunctionLibrary * GetLocalFunctionLibrary()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual TArray< FRigVMVariantRef > GetMatchingVariants()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="Variants"

virtual URigVMGraph * GetModel ( const FString& InNodePath
) const

   RigVMEditorAsset.h  

virtual URigVMGraph * GetModel ( const UEdGraph* InEdGraph
) const

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual UObject * GetObject()

   RigVMEditorAsset.h  

virtual UObject * GetObjectBeingDebugged ( bool bEvenIfPendingKill
)

   RigVMEditorAsset.h  

virtual UObject * GetObjectBeingDebugged ( bool bEvenIfPendingKill
) const

   RigVMEditorAsset.h  

virtual const FString & GetObjectBeingDebuggedPath()

   RigVMEditorAsset.h  
  RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual URigVMController * GetOrCreateController ( const UEdGraph* InGraph
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual URigVMFunctionLibrary * GetOrCreateLocalFunctionLibrary ( bool bSetupUndoRedo
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual const FLazyName & GetPanelNodeFactoryName()

 Returns true if a given panel node factory is compatible this blueprint RigVMEditorAsset.h  

virtual const FLazyName & GetPanelPinFactoryName()

 Returns true if a given panel pin factory is compatible this blueprint RigVMEditorAsset.h  

virtual const TArray< FRigVMGraphFunctionHeader > & GetPublicGraphFunctions()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual TArray< FSoftObjectPath > & GetReferencedObjectPaths()

   RigVMEditorAsset.h  

virtual const TArray< FString > & GetRequiredPlugins ( bool bRefresh
) const

 Returns the names of the plugins required to be loaded for this asset to work RigVMEditorAsset.h  

virtual FRigVMEdGraphDisplaySettings & GetRigGraphDisplaySettings()

   RigVMEditorAsset.h  

virtual FRigVMExtendedExecuteContext * GetRigVMExtendedExecuteContext()

   RigVMEditorAsset.h  

virtual UClass * GetRigVMGeneratedClassPrototype()

   RigVMEditorAsset.h  

virtual URigVMGraph * GetRigVMGraphForEditorObject ( UObject* InObject
) const

   RigVMEditorAsset.h  

virtual UClass * GetRuntimeAssetClass()

   RigVMEditorAsset.h  

virtual TArray< FName > & GetSupportedEventNames()

   RigVMEditorAsset.h  

virtual TArray< TObjectPtr< UEdGraph > > & GetUberGraphs()

   RigVMEditorAsset.h  

virtual TMap< FString, FSoftObjectPath > & GetUserDefinedEnumToPathName ( bool bFromCDO
)

   RigVMEditorAsset.h  

virtual TMap< FString, FSoftObjectPath > & GetUserDefinedStructGuidToPathName ( bool bFromCDO
)

   RigVMEditorAsset.h  

virtual TSet< TObjectPtr< UObject > > & GetUserDefinedTypesInUse ( bool bFromCDO
)

   RigVMEditorAsset.h  

virtual FString GetVariableCategory ( const FName& InName
)

   RigVMEditorAsset.h  

virtual FString GetVariableDefaultValue ( const FName& InName,
bool bFromDebuggedObject
) const

   RigVMEditorAsset.h  

virtual FString GetVariableMetadataValue ( const FName& InName,
const FName& InKey
)

   RigVMEditorAsset.h  

virtual uint8 * GetVariablesMemory()

   RigVMEditorAsset.h  

virtual FRigVMPropertyBag * GetVariablesPropertyBag()

   RigVMEditorAsset.h  

virtual const UStruct * GetVariablesStruct()

   RigVMEditorAsset.h  

virtual FText GetVariableTooltip ( const FName& InName
) const

   RigVMEditorAsset.h  

virtual URigVM * GetVM ( bool bCreateIfNeeded
) const

 Virtual UClass* GetRigVMGeneratedClass() override { return nullptr; } RigVMEditorAsset.h  

virtual FRigVMCompileSettings & GetVMCompileSettings()

   RigVMEditorAsset.h  

virtual FRigVMRuntimeSettings & GetVMRuntimeSettings()

   RigVMEditorAsset.h  

virtual UWorld * GetWorldBeingDebugged()

   RigVMEditorAsset.h  

virtual void HandleConfigureRigVMController ( const FRigVMClient* InClient,
URigVMController* InControllerToConfigure
)

   RigVMEditorAsset.h  

virtual void HandleRigVMGraphAdded ( const FRigVMClient* InClient,
const FString& InNodePath
)

   RigVMEditorAsset.h  

virtual void HandleRigVMGraphRemoved ( const FRigVMClient* InClient,
const FString& InNodePath
)

   RigVMEditorAsset.h  

virtual void HandleRigVMGraphRenamed ( const FRigVMClient* InClient,
const FString& InOldNodePath,
const FString& InNewNodePath
)

   RigVMEditorAsset.h  

virtual void IncrementVMRecompileBracket()

   RigVMEditorAsset.h  

virtual bool IsFunctionPublic ( const FName& InFunctionName
) const

   RigVMEditorAsset.h  

virtual bool IsPinBeingWatched ( const UEdGraphPin* InPin
) const

   RigVMEditorAsset.h  

virtual bool & IsReferencedObjectPathsStored()

   RigVMEditorAsset.h  

virtual bool IsRegeneratingOnLoad()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool IsUpToDate()

   RigVMEditorAsset.h  

virtual bool JoinAssetVariant ( const FGuid& InGuid
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="Variants"

virtual void MarkAssetAsModified ( FPropertyChangedEvent PropertyChangedEvent
)

   RigVMEditorAsset.h  

virtual void MarkAssetAsStructurallyModified ( bool bSkipDirtyAssetStatus
)

   RigVMEditorAsset.h  

virtual void MarkFunctionPublic ( const FName& InFunctionName,
bool bIsPublic
)

   RigVMEditorAsset.h  

virtual bool NodeContainsWatchedPins ( const UEdGraphNode* InNode
) const

   RigVMEditorAsset.h  

virtual void NotifyGraphRenamedSuper ( UEdGraph* Graph,
FName OldName,
FName NewName
)

   RigVMEditorAsset.h  

virtual FString OnCopyVariable ( const FName& InName
) const

   RigVMEditorAsset.h  

virtual FRigVMGetFocusedGraph & OnGetFocusedGraph ()

   RigVMEditorAsset.h  

virtual const FRigVMGetFocusedGraph & OnGetFocusedGraph ()

   RigVMEditorAsset.h  

virtual FRigVMGraphModifiedEvent & OnModified()

   RigVMEditorAsset.h  

virtual bool OnPasteVariable ( const FString& InText
)

   RigVMEditorAsset.h  

virtual FOnRigVMPostVariablesChanged & OnPostVariablesChanged()

   RigVMEditorAsset.h  

virtual FOnRigVMPreVariablesChanged & OnPreVariablesChanged()

   RigVMEditorAsset.h  

virtual void OnRigVMRegistryChanged()

 RigVMRegistry changes can be triggered when new user defined types(structs/enums) are added/removed in which case we have to refresh the model RigVMEditorAsset.h  

virtual void PostDuplicateSuper ( bool bDuplicateForPIE
)

   RigVMEditorAsset.h  

virtual void PostEditChangeBlueprintActors()

   RigVMEditorAsset.h  

virtual void PostSerialize ( FArchive& Ar
)

   RigVMEditorAsset.h  

virtual void PostTransactedSuper ( const FTransactionObjectEvent& TransactionEvent
)

   RigVMEditorAsset.h  

virtual void PreCompile()

   RigVMEditorAsset.h  

virtual void PreDuplicateSuper ( FObjectDuplicationParameters& DupParams
)

   RigVMEditorAsset.h  

virtual void RecompileVM()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual void RecompileVMIfRequired()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual void RefreshAllModels ( ERigVMLoadType InLoadType
)

 This is needed since even after load model data can change while the RigVM BP is not opened for example, if a user defined struct changed after BP load, any pin that references the struct needs to be regenerated RigVMEditorAsset.h  

virtual bool RemoveMemberVariable ( const FName& InName
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool RemoveModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual void RemovePinWatch ( UEdGraphPin* InPin
)

   RigVMEditorAsset.h  

virtual void RenameGraph ( const FString& InNodePath,
const FName& InNewName
)

   RigVMEditorAsset.h  

virtual bool RenameMemberVariable ( const FName& InOldName,
const FName& InNewName
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual void ReplaceDeprecatedNodesSuper()

   RigVMEditorAsset.h  

virtual void RequestAutoVMRecompilation()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual bool RequiresForceLoadMembersSuper ( UObject* InObject
) const

   RigVMEditorAsset.h  

virtual void SerializeSuper ( FArchive& Ar
)

   RigVMEditorAsset.h  

virtual void SetAssetStatus ( const ERigVMAssetStatus& InStatus
)

   RigVMEditorAsset.h  

virtual void SetAutoVMRecompile ( bool bAutoRecompile
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

virtual void SetObjectBeingDebuggedSuper ( UObject* NewObject
)

   RigVMEditorAsset.h  

virtual void SetPublicGraphFunctions ( const TArray< FRigVMGraphFunctionHeader >& InHeaders
)

   RigVMEditorAsset.h  

virtual void SetUberGraphs ( const TArray< TObjectPtr< UEdGraph > >& InGraphs
)

   RigVMEditorAsset.h  

virtual void SetupPinRedirectorsForBackwardsCompatibility()

   RigVMEditorAsset.h  

virtual bool SetVariableCategory ( const FName& InName,
const FString& InCategory
)

   RigVMEditorAsset.h  

virtual bool SetVariableExposeOnSpawn ( const FName& InName,
const bool bInExposeOnSpawn
)

   RigVMEditorAsset.h  

virtual bool SetVariableExposeToCinematics ( const FName& InName,
const bool bInExposeToCinematics
)

   RigVMEditorAsset.h  

virtual bool SetVariableIndex ( const FName& InName,
int32 NewIndex
)

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="VM"

virtual bool SetVariablePrivate ( const FName& InName,
const bool bInPrivate
)

   RigVMEditorAsset.h  

virtual bool SetVariablePublic ( const FName& InName,
const bool bIsPublic
)

   RigVMEditorAsset.h  

virtual bool SetVariableTooltip ( const FName& InName,
const FText& InTooltip
)

   RigVMEditorAsset.h  

virtual void SetWorldBeingDebugged ( UWorld* NewWorld
)

   RigVMEditorAsset.h  

virtual bool SplitAssetVariant()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="Variants"

virtual void UpdateSupportedEventNames()

   RigVMEditorAsset.h  

Overridden from IRigVMClientHost

Name Remarks Include Path Unreal Specifiers

virtual TArray< FString > GeneratePythonCommands ( const FString InNewBlueprintName
)

   RigVMEditorAsset.h  

virtual FString GetAssetName()

 Returns the expected schema class to use for this blueprint RigVMEditorAsset.h  
Returns the rigvm client for this host. RigVMEditorAsset.h  

virtual const FRigVMClient * GetRigVMClient ()

 Returns the rigvm client for this host. RigVMEditorAsset.h  

virtual UClass * GetRigVMEdGraphClass()

 Returns the expected ed graph class to use for this blueprint RigVMEditorAsset.h  

virtual UClass * GetRigVMEdGraphNodeClass()

 Returns the expected ed graph node class to use for this blueprint RigVMEditorAsset.h  

virtual UClass * GetRigVMEdGraphSchemaClass()

 Returns the expected ed graph schema class to use for this blueprint RigVMEditorAsset.h  

virtual UClass * GetRigVMEditorSettingsClass()

 Returns the class of the settings to use RigVMEditorAsset.h  

virtual UScriptStruct * GetRigVMExecuteContextStruct()

 Returns the expected execute context struct to use for this blueprint RigVMEditorAsset.h  
Returns the rigvm function host. RigVMEditorAsset.h  
Returns the rigvm function host. RigVMEditorAsset.h  

virtual UClass * GetRigVMSchemaClass()

 Returns the expected schema class to use for this blueprint RigVMEditorAsset.h  

virtual void RequestRigVMInit()

   RigVMEditorAsset.h
  • BlueprintCallable
  • Category="RigVM Asset"

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   RigVMEditorAsset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page