documentation on EFlowFinishPolicy

MothCocoon · Nov 29, 2021 · d8dab6c · d8dab6c
1 parent 7ad4dd7
commit d8dab6c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/Source/Flow/Public/FlowSubsystem.h b/Source/Flow/Public/FlowSubsystem.h
@@ -63,7 +63,9 @@ class FLOW_API UFlowSubsystem : public UGameInstanceSubsystem
 
 	UFlowAsset* CreateRootFlow(UObject* Owner, UFlowAsset* FlowAsset, const bool bAllowMultipleInstances = true);
 
-	// Finish the root Flow, typically when closing world that created this flow
+	// Finish Policy value is read by Flow Node
+	// Nodes have opportunity to terminate themselves differently if Flow Graph has been aborted
+	// Example: Spawn node might despawn all actors if Flow Graph is aborted, not completed
 	UFUNCTION(BlueprintCallable, Category = "FlowSubsystem")
 	void FinishRootFlow(UObject* Owner, const EFlowFinishPolicy FinishPolicy);
 

diff --git a/Source/Flow/Public/FlowTypes.h b/Source/Flow/Public/FlowTypes.h
@@ -27,6 +27,9 @@ enum class EFlowNodeState : uint8
 	Aborted
 };
 
+// Finish Policy value is read by Flow Node
+// Nodes have opportunity to terminate themselves differently if Flow Graph has been aborted
+// Example: Spawn node might despawn all actors if Flow Graph is aborted, not completed
 UENUM(BlueprintType)
 enum class EFlowFinishPolicy : uint8
 {