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&40;BlueprintType, Meta&61;&40;IgnoreClassThumbnail&41;&41;  
class URigVMBlueprint :  
    public UBlueprint,  
    public IRigVMClientHost

Variables

  Type Name Description
Protected variable TMap< FName, int32 > AddedMemberVariableMap  
Public variable bool bSuspendAllNotifications  
Public variable bool bSuspendModelNotificationsForOthers  
Public variable bool bSuspendModelNotificationsForSelf  
Protected variable TArray< FAssetRegistryTag > CachedAssetTags  
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 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 UFunction BlueprintCallable, Category URigVMGraph *

AddModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

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

  
Public function void  
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 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 void  
Protected function Static FName

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

  
Public function Virtual UFunction BlueprintCallable, Category TArray< FString >

GeneratePythonCommands ( const FString InNewBlueprintName
)

  
Public function Const UFunction BlueprintCallable, Category TArray< URigVMGraph * >  
Public function Const UFunction BlueprintPure, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category TArray< UStruct * >  
Public function FCompilerResultsLog &  
Public function Const const FCompilerResultsLog &  
Public function Const URigVMController *

GetController ( const UEdGraph* InEdGraph
)

  
Public function Const UFunction BlueprintCallable, Category URigVMController *

GetController ( const URigVMGraph* InGraph
)

  
Public function Const UFunction BlueprintCallable, Category URigVMController *

GetControllerByName ( const FString InGraphName
)

  
Public function Const UFunction BlueprintCallable, Category URigVMGraph *  
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 Const UFunction BlueprintCallable, Category URigVMGraph *  
Public function Const UFunction BlueprintCallable, Category URigVMFunctionLibrary *  
Public function Const UFunction BlueprintCallable, Category TArray< FRigVMGraphVariableDescription >  
Public function Const URigVMGraph *

GetModel ( const FString& InNodePath
)

  
Public function Const UFunction BlueprintCallable, Category URigVMGraph *

GetModel ( const UEdGraph* InEdGraph
)

  
Public function URigVMController *

GetOrCreateController ( const UEdGraph* InGraph
)

  
Public function UFunction BlueprintCallable, Category URigVMController *  
Public function Virtual Const const FName & Returns true if a given panel node factory is compatible this blueprint
Public function Virtual Const const FName & Returns true if a given panel pin factory is compatible this blueprint
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 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 Const URigVMEditorSettings * Returns the settings defaults 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 Const UFunction BlueprintCallable, Category UClass *  
Public function Virtual Const UClass * Returns the expected schema class to use for this blueprint
Public function URigVMController *

GetTemplateController ( bool bIsFunctionLibrary
)

  
Public function URigVMGraph *

GetTemplateModel ( bool bIsFunctionLibrary
)

  
Protected function Virtual void  
Public function void  
Public function void

InitializeModelIfRequired ( bool bRecompileVM
)

  
Public function Const bool

IsFunctionPublic ( const FName& InFunctionName
)

  
Public function Const bool  
Protected function void  
Public function void

MarkFunctionPublic ( const FName& InFunctionName,
bool bIsPublic
)

  
Public function FOnRigVMBreakpointAdded &  
Public function FOnRigVMExternalVariablesChanged &  
Public function FRigVMBlueprintGetFocusedGraph &  
Public function FOnRigVMGraphImported &  
Public function FRigVMGraphModifiedEvent &  
Public function FOnRigVMNodeDoubleClicked &  
Public function FOnRigVMPostEditChangeChainProperty &  
Public function Virtual void

OnPostVariableChange ( UBlueprint* InBlueprint
)

  
Public function Virtual void  
Public function FOnRigVMRefreshEditorEvent &  
Public function FOnRigVMReportCompilerMessage &  
Public function FRigVMOnBreakLinksDialogRequestedDelegate &  
Public function FRigVMOnBulkEditDialogRequestedDelegate &  
Public function FOnRigVMRequestInspectObject &  
Public function FRigVMController_RequestJumpToHyperlinkDelegate &  
Public function FOnRigVMLocalizeFunctionDialogRequested &  
Public function FRigVMOnPinTypeSelectionRequestedDelegate &  
Public function 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 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 void  
Public function void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function 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 void Recomputes the instruction breakpoints given the node breakpoints in the blueprint
Public function bool

RemoveBreakpoint ( URigVMNode* InBreakpointNode
)

 Removes the given breakpoint from all the loaded blueprints that use this node, and recomputes all breakpoints in the VM
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

RemoveModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category void  
Public function void

RequestInspectObject ( const TArray< UObject* >& InObjects
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetAutoVMRecompile ( bool bAutoRecompile
)

  
Public function void

SetDebugMode ( const bool bValue
)

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

Overridden from UBlueprint

  Type Name Description
Public function Virtual bool

CanImportGraphFromText ( const FString& InClipboardText
)

 Returns true if the blueprint can import a given InClipboardText.
Public function Virtual bool

ExportGraphToText ( UEdGraph* InEdGraph,
FString& OutText
)

 Copies a given graph into a text buffer. Returns true if successful.
Public function Virtual Const UClass * Gets the class generated when this blueprint is compiled.
Public function Virtual Const void Allow each blueprint instance to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
Public function Virtual Const void Allow each blueprint type (AnimBlueprint or ControlRigBlueprint) to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
Public function Virtual Const bool Whether or not this blueprint can be considered for a bytecode only compile
Public function Virtual void Blueprint can choose to load specific modules for compilation.
Public function Virtual void Checks all nodes in all graphs to see if they should be replaced by other nodes
Public function Virtual Const bool  
Public function Virtual void Sets the current object being debugged
Public function Virtual Const bool Returns true if this blueprint should be marked dirty upon a transaction
Public function Virtual Const bool Should the generic blueprint factory work for this blueprint?
Public function Virtual Const bool Returns true if this blueprint supports animation layers
Public function Virtual Const bool Returns true if this blueprint supports delegates
Public function Virtual Const bool Returns true if this blueprint supports event graphs
Public function Virtual Const bool Returns true if this blueprint supports functions
Public function Virtual Const bool Returns true if this blueprint supports global variables
Public function Virtual Const bool Returns true if this blueprint supports global variables
Public function Virtual Const bool Returns true if this blueprint supports macros
Public function Virtual bool

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

 Returns a new ed graph if the blueprint's specialization imported a graph based on a clipboard text content an nullptr if that's not successful.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void Called during cooking.
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

 Called at the end of Rename(), but only if the rename was actually carried out
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

 Called after the object has been transacted in some way.
Public function Virtual void Called before duplication.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual UClass *

RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

 Called on the target when a class is loaded with ClassGeneratedBy is loaded.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IRigVMClientHost

  Type Name Description
Public function Virtual Const UObject * Returns the editor object corresponding with the supplied editor object.
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 IRigVMGraphFunctionHost * Returns the rigvm function host.
Public function Virtual Const const IRigVMGraphFunctionHost * Returns the rigvm function host.
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.

Constants

Name Description
PreDuplicateAssetPath  
PreDuplicateHostPath  
RigVMPanelNodeFactoryName  
RigVMPanelPinFactoryName  
sCurrentlyOpenedRigVMBlueprints  

Deprecated Variables

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

Deprecated Functions

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page