Decoupled triggering breakpoints from the Flow Editor module

* UFlowGraphNode no longer operate on breakpoints.
* UFlowDebuggerSubsystem binds directly to runtime OnPinTriggered delegate.
* Pin breakpoint is now identified as NodeGuid and PinName instead of UEdGraphPin. This way it's possible to bind to OnPinTriggered delegate outside of editor! Events shall be receive in Standalone game, non-shipping game builds.
* Wrapped UEdGraphNode pointer in runtime Flow Node class with WITH_EDITORONLY_DATA as this isn't even loaded in Standalone game.

Author: MothDoctor

Source/Flow/Private/FlowAsset.cpp

@@ -31,7 +31,7 @@ FString UFlowAsset::ValidationError_NullNodeInstance = TEXT("Node with GUID {0}
 UFlowAsset::UFlowAsset(const FObjectInitializer& ObjectInitializer)
 	: Super(ObjectInitializer)
 	, bWorldBound(true)
-#if WITH_EDITOR
+#if WITH_EDITORONLY_DATA
 	, FlowGraph(nullptr)
 #endif
 	, AllowedNodeClasses({UFlowNodeBase::StaticClass()})
@@ -293,14 +293,6 @@ bool UFlowAsset::CanFlowAssetReferenceFlowNode(const UClass& FlowNodeClass, FTex
 	return true;
 }
 
-TSharedPtr<IFlowGraphInterface> UFlowAsset::FlowGraphInterface = nullptr;
-
-void UFlowAsset::SetFlowGraphInterface(TSharedPtr<IFlowGraphInterface> InFlowAssetEditor)
-{
-	check(!FlowGraphInterface.IsValid());
-	FlowGraphInterface = InFlowAssetEditor;
-}
-
 UFlowNode* UFlowAsset::CreateNode(const UClass* NodeClass, UEdGraphNode* GraphNode)
 {
 	UFlowNode* NewNode = NewObject<UFlowNode>(this, NodeClass, NAME_None, RF_Transactional);
@@ -1473,9 +1465,9 @@ bool UFlowAsset::IsBoundToWorld_Implementation()
 void UFlowAsset::LogError(const FString& MessageToLog, const UFlowNodeBase* Node) const
 {
 	// this is runtime log which is should be only called on runtime instances of asset
-	if (TemplateAsset == nullptr)
+	if (TemplateAsset)
 	{
-		UE_LOG(LogFlow, Log, TEXT("Attempted to use Runtime Log on null template asset %s"), *MessageToLog);
+		UE_LOG(LogFlow, Log, TEXT("Attempted to use Runtime Log on asset instance %s"), *MessageToLog);
 	}
 
 	if (RuntimeLog.Get())
@@ -1488,9 +1480,9 @@ void UFlowAsset::LogError(const FString& MessageToLog, const UFlowNodeBase* Node
 void UFlowAsset::LogWarning(const FString& MessageToLog, const UFlowNodeBase* Node) const
 {
 	// this is runtime log which is should be only called on runtime instances of asset
-	if (TemplateAsset == nullptr)
+	if (TemplateAsset)
 	{
-		UE_LOG(LogFlow, Log, TEXT("Attempted to use Runtime Log on null template asset %s"), *MessageToLog);
+		UE_LOG(LogFlow, Log, TEXT("Attempted to use Runtime Log on asset instance %s"), *MessageToLog);
 	}
 
 	if (RuntimeLog.Get())
@@ -1503,9 +1495,9 @@ void UFlowAsset::LogWarning(const FString& MessageToLog, const UFlowNodeBase* No
 void UFlowAsset::LogNote(const FString& MessageToLog, const UFlowNodeBase* Node) const
 {
 	// this is runtime log which is should be only called on runtime instances of asset
-	if (TemplateAsset == nullptr)
+	if (TemplateAsset)
 	{
-		UE_LOG(LogFlow, Log, TEXT("Attempted to use Runtime Log on null template asset %s"), *MessageToLog);
+		UE_LOG(LogFlow, Log, TEXT("Attempted to use Runtime Log on asset instance %s"), *MessageToLog);
 	}
 
 	if (RuntimeLog.Get())

Source/Flow/Private/FlowSubsystem.cpp

@@ -17,7 +17,7 @@
 
 #include UE_INLINE_GENERATED_CPP_BY_NAME(FlowSubsystem)
 
-#if WITH_EDITOR
+#if !UE_BUILD_SHIPPING
 FNativeFlowAssetEvent UFlowSubsystem::OnInstancedTemplateAdded;
 FNativeFlowAssetEvent UFlowSubsystem::OnInstancedTemplateRemoved;
 #endif

Source/Flow/Private/Nodes/FlowNode.cpp

@@ -76,21 +76,15 @@ void UFlowNode::PostLoad()
 
 bool UFlowNode::IsSupportedInputPinName(const FName& PinName) const
 {
+	const FFlowPin* InputPin = FindFlowPinByName(PinName, InputPins);
+
 	if (AddOns.IsEmpty())
 	{
-		checkf(FindFlowPinByName(PinName, InputPins), TEXT("Only AddOns should introduce unknown Pins to a FlowNode, so if we have no AddOns, we should have no unknown pins"));
-
+		checkf(InputPin, TEXT("Only AddOns should introduce unknown Pins to a FlowNode, so if we have no AddOns, we should have no unknown pins"));
 		return true;
 	}
 
-	if (const FFlowPin* FoundInputFlowPin = FindFlowPinByName(PinName, InputPins))
-	{
-		return true;
-	}
-	else
-	{
-		return false;
-	}
+	return (InputPin != nullptr);
 }
 
 void UFlowNode::AddInputPins(const TArray<FFlowPin>& Pins)
@@ -813,23 +807,19 @@ void UFlowNode::TriggerInput(const FName& PinName, const EFlowPinActivationType
 		TArray<FPinRecord>& Records = InputRecords.FindOrAdd(PinName);
 		Records.Add(FPinRecord(FApp::GetCurrentTime(), ActivationType));
 
-		LogVerbose(FString::Printf(TEXT("Triggering input %s."), *PinName.ToString()));
-#endif // UE_BUILD_SHIPPING
-
-#if WITH_EDITOR
-		if (GEditor && UFlowAsset::GetFlowGraphInterface().IsValid())
+		if (const UFlowAsset* FlowAssetTemplate = GetFlowAsset()->GetTemplateAsset())
 		{
-			UFlowAsset::GetFlowGraphInterface()->OnInputTriggered(GraphNode, InputPins.IndexOfByKey(PinName));
+			(void)FlowAssetTemplate->OnPinTriggered.ExecuteIfBound(NodeGuid, PinName);
 		}
-#endif // WITH_EDITOR
+#endif
 	}
+#if !UE_BUILD_SHIPPING
 	else
 	{
-#if !UE_BUILD_SHIPPING
 		LogError(FString::Printf(TEXT("Input Pin name %s invalid"), *PinName.ToString()));
-#endif // UE_BUILD_SHIPPING
 		return;
 	}
+#endif
 
 	switch (SignalMode)
 	{
@@ -883,24 +873,15 @@ void UFlowNode::TriggerOutput(const FName PinName, const bool bFinish /*= false*
 		TArray<FPinRecord>& Records = OutputRecords.FindOrAdd(PinName);
 		Records.Add(FPinRecord(FApp::GetCurrentTime(), ActivationType));
 
-		LogVerbose(FString::Printf(TEXT("\n Triggering output: %s.  bFinish: %s "), *PinName.ToString(), bFinish ? TEXT("true") : TEXT("false")));
-
-#if WITH_EDITOR
-		if (GEditor && UFlowAsset::GetFlowGraphInterface().IsValid())
+		if (const UFlowAsset* FlowAssetTemplate = GetFlowAsset()->GetTemplateAsset())
 		{
-			UFlowAsset::GetFlowGraphInterface()->OnOutputTriggered(GraphNode, OutputPins.IndexOfByKey(PinName));
+			FlowAssetTemplate->OnPinTriggered.ExecuteIfBound(NodeGuid, PinName);
 		}
-#endif
 	}
 	else
 	{
 		LogError(FString::Printf(TEXT("Output Pin name %s invalid"), *PinName.ToString()));
 	}
-#endif // UE_BUILD_SHIPPING
-
-#if WITH_EDITOR
-	LogVerbose(FString::Printf(TEXT("\n Description: %s"), *GetNodeDescription()));
-	LogVerbose(FString::Printf(TEXT("\n Status: %s"), *GetStatusStringForNodeAndAddOns()));
 #endif
 
 	// call the next node
@@ -924,7 +905,7 @@ void UFlowNode::Deactivate()
 		// there is nothing to deactivate, node was never active
 		return;
 	}
-	
+
 	if (GetFlowAsset()->FinishPolicy == EFlowFinishPolicy::Abort)
 	{
 		ActivationState = EFlowNodeState::Aborted;
@@ -1077,7 +1058,7 @@ FString UFlowNode::GetStatusStringForNodeAndAddOns() const
 	FString CombinedStatusString = GetStatusString();
 
 	// Give all of the AddOns a chance to add their status strings as well
-	(void) ForEachAddOnConst(
+	(void)ForEachAddOnConst(
 		[&CombinedStatusString](const UFlowNodeAddOn& AddOn)
 		{
 			const FString AddOnStatusString = AddOn.GetStatusString();

Source/Flow/Private/Nodes/FlowNodeBase.cpp

@@ -30,8 +30,8 @@ using namespace EFlowForEachAddOnFunctionReturnValue_Classifiers;
 
 UFlowNodeBase::UFlowNodeBase(const FObjectInitializer& ObjectInitializer)
 	: Super(ObjectInitializer)
-	, GraphNode(nullptr)
 #if WITH_EDITORONLY_DATA
+	, GraphNode(nullptr)
 	, bDisplayNodeTitleWithoutPrefix(true)
 	, bCanDelete(true)
 	, bCanDuplicate(true)
@@ -575,17 +575,14 @@ EFlowForEachAddOnFunctionReturnValue UFlowNodeBase::ForEachAddOnForClass(const U
 	return ReturnValue;
 }
 
+#if WITH_EDITOR
 void UFlowNodeBase::PostLoad()
 {
 	Super::PostLoad();
 
-#if WITH_EDITOR
 	EnsureNodeDisplayStyle();
-#endif
 }
 
-#if WITH_EDITOR
-
 void UFlowNodeBase::SetGraphNode(UEdGraphNode* NewGraphNode)
 {
 	GraphNode = NewGraphNode;
@@ -726,7 +723,7 @@ FText UFlowNodeBase::GetGeneratedDisplayName() const
 
 void UFlowNodeBase::EnsureNodeDisplayStyle()
 {
-	// todo: remove in Flow 2.1
+	// todo: remove in Flow 2.2
 
 	// Backward compatibility update to convert NodeStyle to NodeDisplayStyle
 	FLOW_ASSERT_ENUM_MAX(EFlowNodeStyle, 7);

Source/Flow/Public/FlowAsset.h

@@ -22,21 +22,9 @@ class UEdGraph;
 class UEdGraphNode;
 class UFlowAsset;
 
-#if WITH_EDITOR
-
-/** Interface for calling the graph editor methods */
-class FLOW_API IFlowGraphInterface
-{
-public:
-	IFlowGraphInterface() {}
-	virtual ~IFlowGraphInterface() {}
-
-	virtual void OnInputTriggered(UEdGraphNode* GraphNode, const int32 Index) const {}
-	virtual void OnOutputTriggered(UEdGraphNode* GraphNode, const int32 Index) const {}
-};
-
+#if !UE_BUILD_SHIPPING
 DECLARE_DELEGATE(FFlowGraphEvent);
-
+DECLARE_DELEGATE_TwoParams(FFlowSignalEvent, const FGuid& /*NodeGuid*/, const FName& /*PinName*/);
 #endif
 
 // Working Data struct for the Harvest Data Pins operation
@@ -96,7 +84,7 @@ class FLOW_API UFlowAsset : public UObject
 	bool bWorldBound;
 
 //////////////////////////////////////////////////////////////////////////
-// Graph
+// Graph (editor-only)
 
 #if WITH_EDITOR
 public:	
@@ -108,13 +96,24 @@ class FLOW_API UFlowAsset : public UObject
 	virtual void PostDuplicate(bool bDuplicateForPIE) override;
 	virtual void PostLoad() override;
 	// --
+#endif	
 
+#if WITH_EDITORONLY_DATA
 public:
 	FSimpleDelegate OnDetailsRefreshRequested;
 
 	static FString ValidationError_NodeClassNotAllowed;
 	static FString ValidationError_NullNodeInstance;
 
+private:
+	UPROPERTY()
+	TObjectPtr<UEdGraph> FlowGraph;
+#endif
+
+#if WITH_EDITOR
+public:
+	UEdGraph* GetGraph() const { return FlowGraph; }
+
 	virtual EDataValidationResult ValidateAsset(FFlowMessageLog& MessageLog);
 
 	// Returns whether the node class is allowed in this flow asset
@@ -129,25 +128,6 @@ class FLOW_API UFlowAsset : public UObject
 	bool IsFlowNodeClassInDeniedClasses(const UClass& FlowNodeClass) const;
 #endif
 
-	// IFlowGraphInterface
-#if WITH_EDITORONLY_DATA
-
-private:
-	UPROPERTY()
-	TObjectPtr<UEdGraph> FlowGraph;
-
-	static TSharedPtr<IFlowGraphInterface> FlowGraphInterface;
-#endif
-
-public:
-#if WITH_EDITOR
-	UEdGraph* GetGraph() const { return FlowGraph; };
-
-	static void SetFlowGraphInterface(TSharedPtr<IFlowGraphInterface> InFlowAssetEditor);
-	static TSharedPtr<IFlowGraphInterface> GetFlowGraphInterface() { return FlowGraphInterface; };
-#endif
-	// -- 
-
 //////////////////////////////////////////////////////////////////////////
 // Nodes
 
@@ -285,7 +265,7 @@ class FLOW_API UFlowAsset : public UObject
 
 	void AddCustomOutput(const FName& EventName);
 	void RemoveCustomOutput(const FName& EventName);
-#endif // WITH_EDITOR
+#endif
 
 //////////////////////////////////////////////////////////////////////////
 // Instances of the template asset
@@ -406,7 +386,6 @@ class FLOW_API UFlowAsset : public UObject
 	TWeakObjectPtr<UFlowAsset> GetFlowInstance(UFlowNode_SubGraph* SubGraphNode) const;
 
 protected:
-
 	void TriggerCustomInput_FromSubGraph(UFlowNode_SubGraph* Node, const FName& EventName) const;
 	void TriggerCustomOutput(const FName& EventName);
 
@@ -415,6 +394,11 @@ class FLOW_API UFlowAsset : public UObject
 	void FinishNode(UFlowNode* Node);
 	void ResetNodes();
 
+#if !UE_BUILD_SHIPPING
+public:	
+	FFlowSignalEvent OnPinTriggered;
+#endif
+	
 public:
 	UFlowSubsystem* GetFlowSubsystem() const;
 	FName GetDisplayName() const;

Source/Flow/Public/FlowSubsystem.h

@@ -49,15 +49,15 @@ class FLOW_API UFlowSubsystem : public UGameInstanceSubsystem
 	UPROPERTY()
 	TMap<TObjectPtr<UFlowNode_SubGraph>, TObjectPtr<UFlowAsset>> InstancedSubFlows;
 
-#if WITH_EDITOR
+#if !UE_BUILD_SHIPPING
 public:
 	/* Called after creating the first instance of given Flow Asset */
 	static FNativeFlowAssetEvent OnInstancedTemplateAdded;
 
 	/* Called just before removing the last instance of given Flow Asset */
 	static FNativeFlowAssetEvent OnInstancedTemplateRemoved;
 #endif
-	
+
 protected:
 	UPROPERTY()
 	TObjectPtr<UFlowSaveGame> LoadedSaveGame;

Source/Flow/Public/Nodes/FlowNodeBase.h

@@ -261,20 +261,19 @@ class FLOW_API UFlowNodeBase
 	UFUNCTION(BlueprintCallable, Category = DataPins, DisplayName = "Try Resolve DataPin As Class")
 	FFlowDataPinResult_Class TryResolveDataPinAsClass(const FName& PinName) const;
 
-	// Public only for for TResolveDataPinWorkingData's use
+	// Public only for TResolveDataPinWorkingData's use
 	EFlowDataPinResolveResult TryResolveDataPinPrerequisites(const FName& PinName, const UFlowNode*& FlowNode, const FFlowPin*& FlowPin, EFlowPinType PinType) const;
 
 public:
 
 //////////////////////////////////////////////////////////////////////////
 // Editor
-// (some editor symbols exposed to enabled creation of non-editor tooling)
-
-	UPROPERTY()
-	TObjectPtr<UEdGraphNode> GraphNode;
 
 #if WITH_EDITORONLY_DATA
 protected:
+	UPROPERTY()
+	TObjectPtr<UEdGraphNode> GraphNode;
+	
 	UPROPERTY(EditDefaultsOnly, Category = "FlowNode")
 	uint8 bDisplayNodeTitleWithoutPrefix : 1;
 
@@ -292,13 +291,12 @@ class FLOW_API UFlowNodeBase
 	FFlowMessageLog ValidationLog;
 #endif // WITH_EDITORONLY_DATA
 
+#if WITH_EDITOR
 public:
-	UEdGraphNode* GetGraphNode() const { return GraphNode; }
-
 	virtual void PostLoad() override;
-
-#if WITH_EDITOR
+	
 	void SetGraphNode(UEdGraphNode* NewGraphNode);
+	UEdGraphNode* GetGraphNode() const { return GraphNode; }
 
 	// Set up UFlowNodeBase when being opened for edit in the editor
 	virtual void SetupForEditing(UEdGraphNode& EdGraphNode);
@@ -316,7 +314,7 @@ class FLOW_API UFlowNodeBase
 	// Called by owning FlowNode to add to its Status String.
 	// (may be multi-line)
 	virtual FString GetStatusString() const;
-#endif
+#endif // WITH_EDITOR
 
 protected:
 	// Information displayed while node is working - displayed over node as NodeInfoPopup
@@ -361,7 +359,7 @@ class FLOW_API UFlowNodeBase
 
 protected:
 	void EnsureNodeDisplayStyle();
-#endif
+#endif // WITH_EDITOR
 
 protected:	
 	// Set the editor-only Config Text