From abafd435ed14afabc090df40632789776a7fd096 Mon Sep 17 00:00:00 2001
From: lsemp3d <58790905+lsemp3d@users.noreply.github.com>
Date: Fri, 12 Nov 2021 09:08:09 -0800
Subject: [PATCH] Added C++ tooltip for custom nodes, updated text for
 AnimAudioComponentRequestBus

Signed-off-by: lsemp3d <58790905+lsemp3d@users.noreply.github.com>
---
 .../AnimAudioComponentRequestBus.names        | 32 +++++++++++--------
 .../Code/Editor/Nodes/NodeDisplayUtils.cpp    |  8 +++++
 .../Code/Include/ScriptCanvas/Core/Node.cpp   |  5 +++
 .../Code/Include/ScriptCanvas/Core/Node.h     |  1 +
 4 files changed, 32 insertions(+), 14 deletions(-)

diff --git a/Gems/ScriptCanvas/Assets/TranslationAssets/EBus/Senders/AnimAudioComponentRequestBus.names b/Gems/ScriptCanvas/Assets/TranslationAssets/EBus/Senders/AnimAudioComponentRequestBus.names
index 41b1962768..3620304e48 100644
--- a/Gems/ScriptCanvas/Assets/TranslationAssets/EBus/Senders/AnimAudioComponentRequestBus.names
+++ b/Gems/ScriptCanvas/Assets/TranslationAssets/EBus/Senders/AnimAudioComponentRequestBus.names
@@ -5,39 +5,41 @@
             "context": "EBusSender",
             "variant": "",
             "details": {
-                "name": "AnimAudioComponentRequestBus"
+                "name": "Audio",
+                "category": "Animation"
             },
             "methods": [
                 {
                     "key": "AddTriggerEvent",
                     "entry": {
                         "name": "In",
-                        "tooltip": "When signaled, this will invoke AddTriggerEvent"
+                        "tooltip": "When signaled, this will invoke Add Trigger Event"
                     },
                     "exit": {
                         "name": "Out",
-                        "tooltip": "Signaled after AddTriggerEvent is invoked"
+                        "tooltip": "Signaled after Add Trigger Event is invoked"
                     },
                     "details": {
-                        "name": "AddTriggerEvent"
+                        "name": "Add Trigger Event",
+                        "tooltip": "Adds audio support to when an animation event is fired"
                     },
                     "params": [
                         {
                             "typeid": "{03AAAB3F-5C47-5A66-9EBC-D5FA4DB353C9}",
                             "details": {
-                                "name": "AZStd::string"
+                                "name": "Event Name"
                             }
                         },
                         {
                             "typeid": "{03AAAB3F-5C47-5A66-9EBC-D5FA4DB353C9}",
                             "details": {
-                                "name": "AZStd::string"
+                                "name": "Trigger Name"
                             }
                         },
                         {
                             "typeid": "{03AAAB3F-5C47-5A66-9EBC-D5FA4DB353C9}",
                             "details": {
-                                "name": "AZStd::string"
+                                "name": "Joint Name"
                             }
                         }
                     ]
@@ -46,34 +48,36 @@
                     "key": "ClearTriggerEvents",
                     "entry": {
                         "name": "In",
-                        "tooltip": "When signaled, this will invoke ClearTriggerEvents"
+                        "tooltip": "When signaled, this will invoke Clear Trigger Events"
                     },
                     "exit": {
                         "name": "Out",
-                        "tooltip": "Signaled after ClearTriggerEvents is invoked"
+                        "tooltip": "Signaled after Clear Trigger Events is invoked"
                     },
                     "details": {
-                        "name": "ClearTriggerEvents"
+                        "name": "Clear Trigger Events",
+                        "tooltip": "Clears all audio support for animation events"
                     }
                 },
                 {
                     "key": "RemoveTriggerEvent",
                     "entry": {
                         "name": "In",
-                        "tooltip": "When signaled, this will invoke RemoveTriggerEvent"
+                        "tooltip": "When signaled, this will invoke Remove Trigger Event"
                     },
                     "exit": {
                         "name": "Out",
-                        "tooltip": "Signaled after RemoveTriggerEvent is invoked"
+                        "tooltip": "Signaled after Remove Trigger Event is invoked"
                     },
                     "details": {
-                        "name": "RemoveTriggerEvent"
+                        "name": "Remove Trigger Event",
+                        "tooltip": "Removes audio support from an anim event"
                     },
                     "params": [
                         {
                             "typeid": "{03AAAB3F-5C47-5A66-9EBC-D5FA4DB353C9}",
                             "details": {
-                                "name": "AZStd::string"
+                                "name": "Event Name"
                             }
                         }
                     ]
diff --git a/Gems/ScriptCanvas/Code/Editor/Nodes/NodeDisplayUtils.cpp b/Gems/ScriptCanvas/Code/Editor/Nodes/NodeDisplayUtils.cpp
index df8486dfa6..083d6d845a 100644
--- a/Gems/ScriptCanvas/Code/Editor/Nodes/NodeDisplayUtils.cpp
+++ b/Gems/ScriptCanvas/Code/Editor/Nodes/NodeDisplayUtils.cpp
@@ -168,6 +168,14 @@ namespace ScriptCanvasEditor::Nodes
 
         GraphCanvas::NodeTitleRequestBus::Event(graphCanvasEntity->GetId(), &GraphCanvas::NodeTitleRequests::SetTitle, details.m_name);
         GraphCanvas::NodeTitleRequestBus::Event(graphCanvasEntity->GetId(), &GraphCanvas::NodeTitleRequests::SetSubTitle, details.m_category);
+
+        // Add to the tooltip the C++ class for reference
+        if (!details.m_tooltip.empty())
+        {
+            details.m_tooltip.append("\n");
+        }
+        details.m_tooltip.append(AZStd::string::format("[C++] %s", node->GetNodeTypeName().c_str()));
+
         GraphCanvas::NodeRequestBus::Event(graphCanvasEntity->GetId(), &GraphCanvas::NodeRequests::SetTooltip, details.m_tooltip);
 
         if (!nodeConfiguration.m_titlePalette.empty())
diff --git a/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.cpp b/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.cpp
index cdff40306f..c4143e7295 100644
--- a/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.cpp
+++ b/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.cpp
@@ -2963,6 +2963,11 @@ namespace ScriptCanvas
         }
     }
 
+    AZStd::string Node::GetNodeTypeName() const
+    {
+        return RTTI_GetTypeName();
+    }
+
     AZStd::string Node::GetDebugName() const
     {
         if (GetEntityId().IsValid())
diff --git a/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.h b/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.h
index 2bd9beb563..ece1cb8274 100644
--- a/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.h
+++ b/Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/Node.h
@@ -525,6 +525,7 @@ namespace ScriptCanvas
 
         void SignalDeserialized();
 
+        virtual AZStd::string GetNodeTypeName() const;
         virtual AZStd::string GetDebugName() const;
         virtual AZStd::string GetNodeName() const;