1. Epic GamesDeveloper
  3. URigVMBlueprint

URigVMBlueprint

API > API/Plugins > API/Plugins/RigVMDeveloper

Inheritance Hierarchy

References

   
Module RigVMDeveloper
Header /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMBlueprint.h
Include #include "RigVMBlueprint.h"

Syntax

UCLASS (BlueprintType, Meta=(IgnoreClassThumbnail))  
class URigVMBlueprint :  
    public UBlueprint,  
    public IRigVMClientHost ,  
    public IRigVMExternalDependencyManager

Variables

  Type Name Description
Protected variable TMap< FName, int32 > AddedMemberVariableMap  
Protected variable UProperty Category, EditAnywhere assetregistrysearchable FRigVMVariant AssetVariant Variant information about this asset
Public variable bool bSuspendAllNotifications  
Public variable bool bSuspendModelNotificationsForSelf  
Protected variable TArray< FAssetRegistryTag > CachedAssetTags  
Protected variable UProperty Transient TObjectPtr< URigVMHost > EditorHost Our currently running rig vm instance
Public variable UProperty TObjectPtr< URigVMEdGraph > FunctionLibraryEdGraph  
Protected variable UProperty assetregistrysearchable TArray< FRigVMReferenceNodeData > FunctionReferenceNodeData Asset searchable information function references in this rig
Protected variable TArray< FBPVariableDescription > LastNewVariables  
Public variable UProperty Transient duplicatetransient TMap< FString, FRigVMOperand > PinToOperandMap  
Protected variable UProperty assetregistrysearchable TArray< FRigVMGraphFunctionHeader > PublicGraphFunctions Asset searchable information about exposed public functions on this rig
Public variable UProperty Category, EditAnywhere FRigVMPythonSettings PythonLogSettings  
Protected variable UProperty TArray< FSoftObjectPath > ReferencedObjectPaths  
Protected variable UProperty bool ReferencedObjectPathsStored  
Public variable UProperty Category, EditAnywhere FRigVMEdGraphDisplaySettings RigGraphDisplaySettings  
Protected variable UProperty FRigVMClient RigVMClient  
Public variable TArray< FString > ShapeLibrariesToLoadOnPackageLoaded Shape libraries to load during package load completed
Protected variable UProperty Transient duplicatetransient TObjectPtr< URigVMController > TemplateController  
Protected variable UProperty Transient duplicatetransient TObjectPtr< URigVMGraph > TemplateModel  
Public variable UProperty TMap< FString, FSoftObjectPath > UserDefinedStructGuidToPathName  
Public variable UProperty Transient TSet< TObjectPtr< UObject > > UserDefinedTypesInUse  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FRigVMCompileSettings VMCompileSettings  
Public variable UProperty Category, EditAnywhere FRigVMRuntimeSettings VMRuntimeSettings  

Constructors

  Type Name Description
Public function    
Public function  

URigVMBlueprint ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool

AddBreakpoint ( const FString& InBreakpointNodePath
)

 Adds a breakpoint to all loaded blueprints which use the node indicated by InBreakpointNodePath If the node is inside a public function, it will add a breakpoint to all blueprints calling this function.
Public function bool

AddBreakpoint ( URigVMNode* InBreakpointNode,
URigVMLibraryNode* LibraryNode
)

 Adds a breakpoint to all loaded blueprints which use the InBreakpointNode.
Public function bool

AddBreakpointToHost ( URigVMNode* InBreakpointNode
)

 Adds a breakpoint to the first instruction of each callpath related to the InBreakpointNode
Protected function Static int32

AddHostMemberVariable ( URigVMBlueprint* InBlueprint,
const FName& InVarName,
FEdGraphPinType InVarType,
bool bIsPublic,
bool bIsReadOnly,
FString InDefaultValue
)

  
Protected function FName

AddHostMemberVariableFromExternal ( FRigVMExternalVariable InVariableToCreate,
FString InDefaultValue
)

  
Public function UFunction BlueprintCallable, Category FName

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

  
Public function void

BroadcastGraphImported ( UEdGraph* InGraph
)

  
Public function void  
Public function void

BroadcastPostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

  
Public function void  
Public function void

BroadCastReportCompilerMessage ( EMessageSeverity::Type InSeverity,
UObject* InSubject,
const FString& InMessage
)

  
Public function void  
Public function Virtual bool

CanImportGraphFromText ( const FString& InClipboardText
)

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function void Removes all the breakpoints from the blueprint and the VM
Public function Static void  
Public function void

CommonInitialization ( const FObjectInitializer& ObjectInitializer
)

  
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category URigVMHost *  
Public function Static void

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

  
Public function Virtual bool

ExportGraphToText ( UEdGraph* InEdGraph,
FString& OutText
)

  
Protected function Static FName

FindHostMemberVariableUniqueName ( TSharedPtr< FKismetNameValidator > InNameValidator,
const FString& InBaseName
)

  
Public function Virtual Const void

GetAssetRegistryTags ( FAssetRegistryTagsContext Context
)

  
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Const const FRigVMVariant &  
Public function Const UFunction BlueprintPure, Category, Meta FRigVMVariant  
Public function Virtual Const UFunction BlueprintCallable, Category TArray< UStruct * >  
Public function Virtual Const UClass *  
Public function FCompilerResultsLog &  
Public function Const const FCompilerResultsLog &  
Public function UFunction BlueprintCallable, Category URigVMHost *  
Public function Const TArray< URigVMBlueprint * >

GetDependencies ( bool bRecursive
)

 Returns a list of dependencies of this blueprint.
Public function Const TArray< FAssetData > Returns a list of dependents as unresolved soft object pointers.
Public function Const TArray< URigVMBlueprint * >

GetDependentBlueprints ( bool bRecursive,
bool bOnlyLoaded
)

 Returns a list of dependents as resolved blueprints.
Public function Const UEdGraph *

GetEdGraph ( const FString& InNodePath
)

  
Public function Const UEdGraph *

GetEdGraph ( URigVMGraph* InModel
)

  
Public function Virtual Const IRigVMEditorModule * Returns the editor module to be used for this blueprint
Public function Virtual Const void  
Public function Const UFunction BlueprintPure, Category TArray< FRigVMVariantRef >  
Public function Const UFunction BlueprintCallable, Category TArray< FRigVMGraphVariableDescription >  
Public function Virtual Const const FLazyName & Returns true if a given panel node factory is compatible this blueprint
Public function Virtual Const const FLazyName & Returns true if a given panel pin factory is compatible this blueprint
Public function Virtual void

GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

 Called during cooking.
Protected function TArray< IRigVMGraphFunctionHost * >

GetReferencedFunctionHosts ( bool bForceLoad
)

  
Public function Const TArray< FRigVMReferenceNodeData >  
Public function Const URigVMBlueprintGeneratedClass * Get the (full) generated class for this rigvm blueprint
Public function Virtual Const UClass * Returns the class used as the super class for all generated classes
Public function Const URigVMBlueprintGeneratedClass * Get the (skeleton) generated class for this rigvm blueprint
Public function Const URigVMEditorSettings * Returns the settings defaults for this blueprint
Public function Const UFunction BlueprintCallable, Category UClass *  
Public function URigVMController *

GetTemplateController ( bool bIsFunctionLibrary
)

  
Public function URigVMGraph *

GetTemplateModel ( bool bIsFunctionLibrary
)

  
Public function Virtual Const void  
Protected function Virtual void  
Public function void  
Public function void

InitializeModelIfRequired ( bool bRecompileVM
)

  
Public function Const bool Returns the execution mode
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category bool

JoinAssetVariant ( const FGuid& InGuid
)

 Merges the asset's guid with a provided one to join the variant set
Public function Virtual void  
Protected function void  
Public function FOnRigVMBreakpointAdded &  
Public function FOnRigVMExternalVariablesChanged &  
Public function FOnRigVMGraphImported &  
Public function FOnRigVMNodeDoubleClicked &  
Public function FOnRigVMPostEditChangeChainProperty &  
Public function Virtual void

OnPostVariableChange ( UBlueprint* InBlueprint
)

  
Public function Virtual void

OnPreVariableChange ( UObject* InObject
)

  
Public function FOnRigVMRefreshEditorEvent &  
Public function FOnRigVMReportCompilerMessage &  
Public function FRigVMOnBreakLinksDialogRequestedDelegate &  
Public function FRigVMOnBulkEditDialogRequestedDelegate &  
Public function FOnRigVMRequestInspectMemoryStorage &  
Public function FOnRigVMRequestInspectObject &  
Public function FRigVMController_RequestJumpToHyperlinkDelegate &  
Public function FOnRigVMLocalizeFunctionDialogRequested &  
Public function FRigVMOnPinTypeSelectionRequestedDelegate &  
Public function Virtual void

OnVariableAdded ( const FName& InVarName
)

  
Public function FOnRigVMVariableDroppedEvent &  
Public function Virtual void

OnVariableRemoved ( const FName& InVarName
)

  
Public function Virtual void

OnVariableRenamed ( const FName& InOldVarName,
const FName& InNewVarName
)

  
Public function Virtual void

OnVariableTypeChanged ( const FName& InVarName,
FEdGraphPinType InOldPinType,
FEdGraphPinType InNewPinType
)

  
Public function FOnRigVMCompiledEvent &  
Protected function Virtual void  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void

PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

  
Public function Virtual void

PostSaveRoot ( FObjectPostSaveRootContext ObjectSaveContext
)

  
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

  
Public function Virtual void

PreDuplicate ( FObjectDuplicationParameters& DupParams
)

  
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void

PreSave ( const ITargetPlatform* TargetPlatform
)

  
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function void  
Public function Static void

QueueCompilerMessageDelegate ( const FOnRigVMReportCompilerMessage::FDelegate& InDelegate
)

  
Public function void  
Public function void Recomputes the instruction breakpoints given the node breakpoints in the blueprint
Public function Virtual UClass *

RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

  
Public function bool

RemoveBreakpoint ( URigVMNode* InBreakpointNode
)

  
Public function bool

RemoveBreakpoint ( const FString& InBreakpointNodePath
)

 Removes the given breakpoint from all the loaded blueprints that use this node, and recomputes all breakpoints in the VM
Public function UFunction BlueprintCallable, Category bool

RemoveMemberVariable ( const FName& InName
)

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function Virtual void  
Public function void

RequestInspectMemoryStorage ( const TArray< FRigVMMemoryStorageStruct* >& InMemoryStorageStructs
)

  
Public function void

RequestInspectObject ( const TArray< UObject* >& InObjects
)

  
Public function Virtual Const bool

RequiresForceLoadMembers ( UObject* InObject
)

  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void

SetDebugMode ( const bool bValue
)

 Sets the execution mode. In Release mode the rig will ignore all breakpoints.
Public function Virtual void

SetObjectBeingDebugged ( UObject* NewObject
)

  
Protected function Virtual void  
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category bool Resets the asset's guid to a new one and splits it from the former variant set
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual bool

TryImportGraphFromText ( const FString& InClipboardText,
UEdGraph** OutGraphPtr
)

  

Overridden from IRigVMClientHost

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category URigVMGraph *

AddModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

  
Public function Virtual void Helper to decrease recompile bracket on nested requests. When value == 1, if autorecompile is enabled, it triggers a VM recompilation.
Public function Virtual UFunction BlueprintCallable, Category TArray< FString >

GeneratePythonCommands ( const FString InNewBlueprintName
)

  
Public function Virtual Const UFunction BlueprintCallable, Category TArray< URigVMGraph * >  
Public function Virtual Const FString IRigVMClientHost interface Start
Public function Virtual Const UFunction BlueprintPure, Category bool Returns current state of automatic recompile flag.
Public function Virtual Const URigVMController *

GetController ( const UEdGraph* InEdGraph
)

  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMController *

GetController ( const URigVMGraph* InGraph
)

  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMController *

GetControllerByName ( const FString InGraphName
)

  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMGraph *  
Public function Virtual Const UObject * Returns the editor object corresponding with the supplied RigVM graph.
Public function Virtual Const UFunction BlueprintCallable, Category URigVMGraph *  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMFunctionLibrary *  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMGraph *

GetModel ( const FString& InNodePath
)

  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMGraph *

GetModel ( const UEdGraph* InEdGraph
)

  
Public function Virtual URigVMController *

GetOrCreateController ( const UEdGraph* InGraph
)

  
Public function Virtual UFunction BlueprintCallable, Category URigVMController *  
Public function Virtual UFunction BlueprintCallable, Category URigVMFunctionLibrary *

GetOrCreateLocalFunctionLibrary ( bool bSetupUndoRedo
)

  
Public function Virtual FRigVMClient * Returns the rigvm client for this host.
Public function Virtual Const const FRigVMClient * Returns the rigvm client for this host.
Public function Virtual Const UClass * Returns the expected ed graph class to use for this blueprint
Public function Virtual Const UClass * Returns the expected ed graph node class to use for this blueprint
Public function Virtual Const UClass * Returns the expected ed graph schema class to use for this blueprint
Public function Virtual Const UClass * Returns the class of the settings to use
Public function Virtual Const UScriptStruct * Returns the expected execute context struct to use for this blueprint
Public function Virtual Const URigVMGraph *

GetRigVMGraphForEditorObject ( UObject* InObject
)

 Returns the RigVM graph corresponding with the supplied editor object.
Public function Virtual Const const IRigVMGraphFunctionHost * Returns the rigvm function host.
Public function Virtual IRigVMGraphFunctionHost * Returns the rigvm function host.
Public function Virtual Const UClass * Returns the expected schema class to use for this blueprint
Public function Virtual void

HandleConfigureRigVMController ( const FRigVMClient* InClient,
URigVMController* InControllerToConfigure
)

 Reacts to a request to configure a controller.
Public function Virtual void

HandleRigVMGraphAdded ( const FRigVMClient* InClient,
const FString& InNodePathOrName
)

 Reacts to adding a graph.
Public function Virtual void

HandleRigVMGraphRemoved ( const FRigVMClient* InClient,
const FString& InNodePathOrName
)

 Reacts to removing a graph.
Public function Virtual void

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

 Reacts to renaming a graph.
Public function Virtual void Helper to increase recompile bracket on nested requests.
Public function Virtual Const bool

IsFunctionPublic ( const FName& InFunctionName
)

  
Public function Virtual void

MarkFunctionPublic ( const FName& InFunctionName,
bool bIsPublic
)

  
Public function Virtual FRigVMGetFocusedGraph &  
Public function Virtual Const const FRigVMGetFocusedGraph &  
Public function Virtual FRigVMGraphModifiedEvent &  
Public function Virtual void RigVMRegistry changes can be triggered when new user defined types(structs/enums) are added/removed in which case we have to refresh the model
Public function Virtual UFunction BlueprintCallable, Category void Recompiles the VM if not already being compiled.
Public function Virtual UFunction BlueprintCallable, Category void Recompiles VM if flagged for recompiling is set.
Public function Virtual void 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
Public function Virtual UFunction BlueprintCallable, Category bool

RemoveModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

  
Public function Virtual void

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

  
Public function Virtual UFunction BlueprintCallable, Category void Flags VM requires recompile, and if auto recompile is enabled and no compile bracket is active, requests a recompilation.
Public function Virtual UFunction BlueprintCallable, Category void  
Public function Virtual Const UObject *

ResolveUserDefinedTypeById ( const FString& InTypeName
)

 Given a type name for a user-defined type, either struct or an enum, returns a pointer to the object definition or nullptr if the client host has no knowledge of such a type.
Public function Virtual UFunction BlueprintCallable, Category void

SetAutoVMRecompile ( bool bAutoRecompile
)

 Sets flag for automatic recompile on model changes.
Public function Virtual void  

Overridden from IRigVMExternalDependencyManager

  Type Name Description
Public function Virtual Const TArray< FRigVMExternalDependency >

GetExternalDependenciesForCategory ( const FName& InCategory
)

  

Constants

Name Description
PreDuplicateAssetPath  
PreDuplicateHostPath  
QueuedCompilerMessageDelegates  
QueuedCompilerMessageDelegatesMutex  
RigVMPanelNodeFactoryName  
RigVMPanelPinFactoryName  
sCurrentlyOpenedRigVMBlueprints  

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< URigVMFunctionLibrary > FunctionLibrary_DEPRECATED  
Protected variable UProperty TObjectPtr< URigVMGraph > Model_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page