Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
A management struct containing graphs and controllers.
| Name | FRigVMClient |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMClient.h |
| Include Path | #include "RigVMModel/RigVMClient.h" |
Syntax
USTRUCT ()
struct FRigVMClient
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMClient() |
RigVMModel/RigVMClient.h |
Structs
| Name | Remarks |
|---|---|
| FRigVMClientAction |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RigVMModelPrefix | TCHAR | RigVMModel/RigVMClient.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDefaultModelCanBeRemoved | bool | RigVMModel/RigVMClient.h | ||
| bIgnoreModelNotifications | bool | RigVMModel/RigVMClient.h | ||
| bSuspendModelNotificationsForOthers | bool | RigVMModel/RigVMClient.h | ||
| bSuspendNotifications | bool | RigVMModel/RigVMClient.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActionStack | TObjectPtr< URigVMActionStack > | RigVMModel/RigVMClient.h |
|
|
| ControllerClass | TSubclassOf< URigVMController > | RigVMModel/RigVMClient.h |
|
|
| Controllers | TMap< FSoftObjectPath, TObjectPtr< URigVMController > > | RigVMModel/RigVMClient.h |
|
|
| ControllersLock | FTransactionallySafeCriticalSection | RigVMModel/RigVMClient.h | ||
| DefaultSchemaClass | TSubclassOf< URigVMSchema > | RigVMModel/RigVMClient.h |
|
|
| ExternalModelHost | TWeakInterfacePtr< IRigVMClientExternalModelHost > | RigVMModel/RigVMClient.h | ||
| FunctionLibrary | TObjectPtr< URigVMFunctionLibrary > | RigVMModel/RigVMClient.h | ||
| Models | TArray< TObjectPtr< URigVMGraph > > | RigVMModel/RigVMClient.h | ||
| OnGetFocusedGraphDelegate | FRigVMGetFocusedGraph | RigVMModel/RigVMClient.h | ||
| OuterClientHost | TWeakObjectPtr< UObject > | RigVMModel/RigVMClient.h | ||
| OuterClientHostLock | FTransactionallySafeCriticalSection | RigVMModel/RigVMClient.h | ||
| OuterClientPropertyName | FName | RigVMModel/RigVMClient.h | ||
| PostGraphModifiedDelegate | FRigVMClientPostGraphModified | Delegate raised after any graph in this client was modified and after the client adopted these changes | RigVMModel/RigVMClient.h | |
| RedoStack | TArray< FRigVMClientAction > | RigVMModel/RigVMClient.h | ||
| UndoRedoIndex | int32 | RigVMModel/RigVMClient.h |
|
|
| UndoStack | TArray< FRigVMClientAction > | RigVMModel/RigVMClient.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMGraph * AddModel
(
const FName& InName, |
RigVMModel/RigVMClient.h | ||
URigVMGraph * AddModel
(
const FName& InName, |
RigVMModel/RigVMClient.h | ||
URigVMGraph * AddModel
(
const FString InName, |
RigVMModel/RigVMClient.h | ||
void AddModel
(
URigVMGraph* InModel, |
RigVMModel/RigVMClient.h | ||
TArray< TObjectPtr< URigVMGraph > >::RangedForConstIteratorType begin () |
RigVMModel/RigVMClient.h | ||
TArray< TObjectPtr< URigVMGraph > >::RangedForIteratorType begin () |
RigVMModel/RigVMClient.h | ||
TObjectPtr< URigVMGraph > CreateContainedGraphModel
(
URigVMCollapseNode* CollapseNode, |
RigVMModel/RigVMClient.h | ||
URigVMGraph * CreateModel
(
const FName& InName, |
RigVMModel/RigVMClient.h | ||
bool DirtyGraphFunctionCompilationData
(
URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
TArray< TObjectPtr< URigVMGraph > >::RangedForIteratorType end () |
RigVMModel/RigVMClient.h | ||
TArray< TObjectPtr< URigVMGraph > >::RangedForConstIteratorType end () |
RigVMModel/RigVMClient.h | ||
FRigVMGraphFunctionStore * FindFunctionStore
(
const URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
URigVMNode * FindNode
(
const FString& InNodePathOrName |
RigVMModel/RigVMClient.h | ||
| RigVMModel/RigVMClient.h | |||
TArray< URigVMGraph * > GetAllModels
(
bool bIncludeFunctionLibrary, |
RigVMModel/RigVMClient.h | ||
TArray< URigVMGraph * > GetAllModelsLeavesFirst
(
bool bIncludeFunctionLibrary |
RigVMModel/RigVMClient.h | ||
URigVMController * GetController
(
const UObject* InEditorSideObject |
RigVMModel/RigVMClient.h | ||
URigVMController * GetController
(
const URigVMGraph* InModel |
RigVMModel/RigVMClient.h | ||
URigVMController * GetController
(
const FString& InNodePathOrName |
RigVMModel/RigVMClient.h | ||
URigVMController * GetController
(
int32 InIndex |
RigVMModel/RigVMClient.h | ||
URigVMController * GetControllerByName
(
const FString InGraphName |
RigVMModel/RigVMClient.h | ||
UScriptStruct * GetDefaultExecuteContextStruct() |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetDefaultModel() |
RigVMModel/RigVMClient.h | ||
URigVMSchema * GetDefaultSchema() |
RigVMModel/RigVMClient.h | ||
TSubclassOf< URigVMSchema > GetDefaultSchemaClass() |
RigVMModel/RigVMClient.h | ||
TArray< FName > GetEntryNames
(
UScriptStruct* InUnitScriptStructFilter |
RigVMModel/RigVMClient.h | ||
UScriptStruct * GetExecuteContextStruct() |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetFocusedModel() |
RigVMModel/RigVMClient.h | ||
URigVMFunctionLibrary * GetFunctionLibrary() |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetModel
(
const FString& InNodePathOrName |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetModel
(
const UObject* InEditorSideObject |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetModel
(
const UEdGraph* InEdGraph |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetModel
(
int32 InIndex |
RigVMModel/RigVMClient.h | ||
const TArray< TObjectPtr< URigVMGraph > > & GetModels() |
RigVMModel/RigVMClient.h | ||
URigVMController * GetOrCreateController
(
int32 InIndex |
RigVMModel/RigVMClient.h | ||
URigVMController * GetOrCreateController
(
const FString& InNodePathOrName |
RigVMModel/RigVMClient.h | ||
URigVMController * GetOrCreateController
(
const URigVMGraph* InModel |
RigVMModel/RigVMClient.h | ||
URigVMController * GetOrCreateController
(
const UObject* InEditorSideObject |
RigVMModel/RigVMClient.h | ||
URigVMFunctionLibrary * GetOrCreateFunctionLibrary
(
bool bSetupUndoRedo, |
RigVMModel/RigVMClient.h | ||
URigVMFunctionLibrary * GetOrCreateFunctionLibrary
(
TSubclassOf< URigVMSchema > InSchemaClass, |
RigVMModel/RigVMClient.h | ||
URigVMSchema * GetOrCreateSchema() |
RigVMModel/RigVMClient.h | ||
UObject * GetOuter() |
RigVMModel/RigVMClient.h | ||
FProperty * GetOuterClientProperty() |
RigVMModel/RigVMClient.h | ||
FRigVMClientPostGraphModified & GetPostGraphModified () |
Returns a delegate raised after a graph in this client was modified. | RigVMModel/RigVMClient.h | |
URigVMSchema * GetSchema() |
RigVMModel/RigVMClient.h | ||
uint32 GetSerializedStructureHash() |
RigVMModel/RigVMClient.h | ||
uint32 GetStructureHash() |
RigVMModel/RigVMClient.h | ||
FName GetUniqueName
(
const FName& InDesiredName |
RigVMModel/RigVMClient.h | ||
void HandleGraphModifiedEvent
(
ERigVMGraphNotifType InNotifType, |
RigVMModel/RigVMClient.h | ||
bool IsFunctionPublic
(
URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
void NotifyOuterOfPropertyChange
(
EPropertyChangeType::Type ChangeType |
RigVMModel/RigVMClient.h | ||
int32 Num() |
RigVMModel/RigVMClient.h | ||
void OnCollapseNodeRemoved
(
const URigVMCollapseNode* InCollapseNode |
RigVMModel/RigVMClient.h | ||
void OnCollapseNodeRenamed
(
const URigVMCollapseNode* InCollapseNode |
RigVMModel/RigVMClient.h | ||
const FRigVMGetFocusedGraph & OnGetFocusedGraph () |
RigVMModel/RigVMClient.h | ||
FRigVMGetFocusedGraph & OnGetFocusedGraph () |
RigVMModel/RigVMClient.h | ||
void PatchFunctionReferencesOnLoad() |
RigVMModel/RigVMClient.h | ||
void PatchFunctionsOnLoad
(
IRigVMGraphFunctionHost* FunctionHost, |
RigVMModel/RigVMClient.h | ||
FRigVMClientPatchResult PatchModelsOnLoad() |
Backwards compatibility | RigVMModel/RigVMClient.h | |
FRigVMClientPatchResult PatchPinDefaultValues() |
RigVMModel/RigVMClient.h | ||
void PostTransacted
(
const FTransactionObjectEvent& TransactionEvent |
RigVMModel/RigVMClient.h | ||
void PreSave
(
FObjectPreSaveContext ObjectSaveContext |
Work to be done before saving | RigVMModel/RigVMClient.h | |
void ProcessDetachedLinks() |
Try to reattach detached links and delete remaining ones | RigVMModel/RigVMClient.h | |
void RefreshAllModels
(
ERigVMLoadType InLoadType, |
RigVMModel/RigVMClient.h | ||
bool RemoveController
(
const URigVMGraph* InModel |
RigVMModel/RigVMClient.h | ||
bool RemoveModel
(
FString InName, |
RigVMModel/RigVMClient.h | ||
bool RemoveModel
(
const FString& InNodePathOrName, |
RigVMModel/RigVMClient.h | ||
| RigVMModel/RigVMClient.h | |||
void Reset() |
RigVMModel/RigVMClient.h | ||
void SetControllerClass
(
TSubclassOf< URigVMController > InControllerClass |
RigVMModel/RigVMClient.h | ||
void SetDefaultExecuteContextStruct
(
UScriptStruct* InExecuteContextStruct |
RigVMModel/RigVMClient.h | ||
void SetDefaultSchemaClass
(
TSubclassOf< URigVMSchema > InSchemaClass |
RigVMModel/RigVMClient.h | ||
void SetExecuteContextStruct
(
UScriptStruct* InExecuteContextStruct |
RigVMModel/RigVMClient.h | ||
void SetExternalModelHost
(
IRigVMClientExternalModelHost* InExternalModelHost |
RigVMModel/RigVMClient.h | ||
void SetFromDeprecatedData
(
URigVMGraph* InDefaultGraph, |
RigVMModel/RigVMClient.h | ||
| RigVMModel/RigVMClient.h | |||
void SetSchemaClass
(
TSubclassOf< URigVMSchema > InSchemaClass |
RigVMModel/RigVMClient.h | ||
bool UpdateDependenciesForFunction
(
const URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
bool UpdateExternalVariablesForFunction
(
const URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
bool UpdateFunctionReferences
(
const FRigVMGraphFunctionHeader& InHeader, |
RigVMModel/RigVMClient.h | ||
bool UpdateGraphFunctionData
(
const URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
bool UpdateGraphFunctionSerializedGraph
(
URigVMLibraryNode* InLibraryNode |
RigVMModel/RigVMClient.h | ||
bool UpgradeAllOccurencesOfNodes
(
const TArray< URigVMNode* >& InNodesToUpgrade, |
RigVMModel/RigVMClient.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void DestroyObject
(
UObject* InObject |
RigVMModel/RigVMClient.h | ||
static FName GetUniqueName
(
UObject* InOuter, |
RigVMModel/RigVMClient.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMClient & operator=
(
const FRigVMClient& InOther |
RigVMModel/RigVMClient.h |