Skip to content

Added addon descriptions to node descriptions, with editor settings option to disable #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: 5.x
Choose a base branch
from
Open

Added addon descriptions to node descriptions, with editor settings option to disable #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc604de
Added missing calls to parent class Cleanup method
Rhillion Feb 18, 2025
b3c7e75
Added addon descriptions to node descriptions, with editor settings o…
Rhillion Feb 19, 2025
e4b8d24
Merge branch 'MothCocoon:5.x' into 5.x
Rhillion Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Source/Flow/Private/Nodes/FlowNodeBase.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,6 +784,20 @@ FString UFlowNodeBase::GetNodeDescription() const
{
return K2_GetNodeDescription();
}

FString UFlowNodeBase::GetNodeDescriptionWithAddons() const
{
FString Description = GetNodeDescription();
FString AddonDescriptions = FString::JoinBy(AddOns,
LINE_TERMINATOR,
[](const UFlowNodeBase* Addon) { return Addon->GetNodeDescriptionWithAddons(); });
if (!AddonDescriptions.IsEmpty())
{
return Description.Append(LINE_TERMINATOR).Append(AddonDescriptions);
}

return Description;
}
#endif

void UFlowNodeBase::SetNodeConfigText(const FText& NodeConfigText)
Expand Down
3 changes: 3 additions & 0 deletions Source/Flow/Public/Nodes/FlowNodeBase.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,9 @@ class FLOW_API UFlowNodeBase
public:
// Short summary of node's content - displayed over node as NodeInfoPopup
virtual FString GetNodeDescription() const;

// Complex summary of node's content including its addons
FString GetNodeDescriptionWithAddons() const;
#endif

protected:
Expand Down
4 changes: 4 additions & 0 deletions Source/FlowEditor/Private/Graph/Nodes/FlowGraphNode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,10 @@ FString UFlowGraphNode::GetNodeDescription() const
{
if (NodeInstance && (GEditor->PlayWorld == nullptr || UFlowGraphEditorSettings::Get()->bShowNodeDescriptionWhilePlaying))
{
if (UFlowGraphEditorSettings::Get()->bShowAddonNodeDescriptions)
{
return NodeInstance->GetNodeDescriptionWithAddons();
}
return NodeInstance->GetNodeDescription();
}

Expand Down
4 changes: 4 additions & 0 deletions Source/FlowEditor/Public/Graph/FlowGraphEditorSettings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ class FLOWEDITOR_API UFlowGraphEditorSettings : public UDeveloperSettings

UPROPERTY(config, EditAnywhere, Category = "Nodes", meta = (EditCondition = "bShowSubGraphPreview"))
FVector2D SubGraphPreviewSize;

// Display descriptions from attached addons in node descriptions
UPROPERTY(EditAnywhere, config, Category = "Nodes")
bool bShowAddonNodeDescriptions = true;

/** Enable hot reload for native flow nodes?
* WARNING: hot reload can easily crash the editor and you can lose progress */
Expand Down