birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved BehaviorProperty method text generation and updated some translations in the process

Browse Source 
Signed-off-by: lsemp3d <58790905+lsemp3d@users.noreply.github.com>
This commit is contained in:
lsemp3d
2021-11-12 13:07:11 -08:00
parent bc73eaac69
commit a0667f7ae8
10 changed files with 522 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/ScriptCanvas/Code/Editor/Nodes/NodeDisplayUtils.cpp
+5 -3
View File
@@ -271,12 +271,13 @@ namespace ScriptCanvasEditor::Nodes
case ScriptCanvas::MethodType::Event:
graphCanvasEntity->CreateComponent<EBusSenderNodeDescriptorComponent>();
break;
case ScriptCanvas::MethodType::Member:
case ScriptCanvas::MethodType::Getter:
case ScriptCanvas::MethodType::Setter:
case ScriptCanvas::MethodType::Member:
case ScriptCanvas::MethodType::Free:
graphCanvasEntity->CreateComponent<ClassMethodNodeDescriptorComponent>();
break;
break;
default:
AZ_Error("ScriptCanvas", false, "Invalid method node type, node creation failed. This node needs to be deleted.");
break;
@@ -304,10 +305,11 @@ namespace ScriptCanvasEditor::Nodes
GraphCanvas::TranslationKey key;
key = isEBusSender ? "EBusSender" : "BehaviorClass";
key << className;
GraphCanvas::TranslationRequestBus::BroadcastResult(details, &GraphCanvas::TranslationRequests::GetDetails, key + ".details", details);
// Set the class' category as the subtitle fallback
details.m_subtitle = details.m_category;
// Set the class' name as the subtitle fallback
details.m_subtitle = details.m_name;
// Get the method's text data
key << "methods" << methodName;
Gems/ScriptCanvas/Code/Editor/View/Widgets/NodePalette/GeneralNodePaletteTreeItemTypes.cpp
-9
View File
@@ -94,15 +94,6 @@ namespace ScriptCanvasEditor
SetName(details.m_name.c_str());
SetToolTip(details.m_tooltip.c_str());
if (propertyStatus == ScriptCanvas::PropertyStatus::Getter)
{
SetName(AZStd::string::format("Get %s", GetName().toUtf8().data()).data());
}
else if (propertyStatus == ScriptCanvas::PropertyStatus::Setter)
{
SetName(AZStd::string::format("Set %s", GetName().toUtf8().data()).data());
}
SetTitlePalette("MethodNodeTitlePalette");
}
Gems/ScriptCanvas/Code/Tools/TranslationGeneration.cpp
+111 -41
View File
@@ -269,6 +269,7 @@ namespace ScriptCanvasEditorTools
}
}
// Results (Output Slots)
const AZ::BehaviorParameter* resultParameter = behaviorMethod->HasResult() ? behaviorMethod->GetResult() : nullptr;
if (resultParameter)
{
@@ -291,6 +292,19 @@ namespace ScriptCanvasEditorTools
}
}
// Behavior Class properties
if (!behaviorClass->m_properties.empty())
{
for (const auto& propertyEntry : behaviorClass->m_properties)
{
AZ::BehaviorProperty* behaviorProperty = propertyEntry.second;
if (behaviorProperty)
{
TranslateBehaviorProperty(behaviorProperty, behaviorClass->m_name, "BehaviorClass", &entry);
}
}
}
translationRoot.m_entries.push_back(entry);
AZStd::string fileName = AZStd::string::format("Classes/%s", className.c_str());
@@ -748,53 +762,109 @@ namespace ScriptCanvasEditorTools
const AZ::BehaviorProperty* behaviorProperty = behaviorPropertyEntry->second;
Entry entry;
TranslateBehaviorProperty(behaviorProperty, "", "Constant", &entry);
TranslationFormat translationRoot;
if (behaviorProperty->m_getter && !behaviorProperty->m_setter)
{
Entry entry;
entry.m_context = "Constant";
entry.m_key = propertyName;
auto methodName = behaviorProperty->m_getter->m_name;
entry.m_details.m_name = methodName;
entry.m_details.m_tooltip = behaviorProperty->m_getter->m_debugDescription ? behaviorProperty->m_getter->m_debugDescription : "";
entry.m_details.m_category = "Constants";
translationRoot.m_entries.push_back(entry);
}
else
{
Entry entry;
entry.m_context = "BehaviorMethod";
if (behaviorProperty->m_getter)
{
entry.m_key = propertyName;
auto methodName = behaviorProperty->m_getter->m_name;
entry.m_details.m_name = methodName;
entry.m_details.m_tooltip = behaviorProperty->m_getter->m_debugDescription ? behaviorProperty->m_getter->m_debugDescription : "";
translationRoot.m_entries.push_back(entry);
}
if (behaviorProperty->m_setter)
{
entry.m_key = propertyName;
auto methodName = behaviorProperty->m_setter->m_name;
entry.m_details.m_name = methodName;
entry.m_details.m_tooltip = behaviorProperty->m_setter->m_debugDescription ? behaviorProperty->m_getter->m_debugDescription : "";
translationRoot.m_entries.push_back(entry);
}
}
translationRoot.m_entries.push_back(entry);
AZStd::string fileName = AZStd::string::format("Properties/%s", behaviorProperty->m_name.c_str());
SaveJSONData(fileName, translationRoot);
}
void TranslationGeneration::TranslateMethod(AZ::BehaviorMethod* behaviorMethod, Method& methodEntry)
{
// Arguments (Input Slots)
if (behaviorMethod->GetNumArguments() > 0)
{
for (size_t argIndex = 0; argIndex < behaviorMethod->GetNumArguments(); ++argIndex)
{
const AZ::BehaviorParameter* parameter = behaviorMethod->GetArgument(argIndex);
Argument argument;
AZStd::string argumentKey = parameter->m_typeId.ToString<AZStd::string>();
AZStd::string argumentName = parameter->m_name;
AZStd::string argumentDescription = "";
Helpers::GetTypeNameAndDescription(parameter->m_typeId, argumentName, argumentDescription);
argument.m_typeId = argumentKey;
argument.m_details.m_name = parameter->m_name;
argument.m_details.m_category = "";
argument.m_details.m_tooltip = argumentDescription;
methodEntry.m_arguments.push_back(argument);
}
}
// Results (Output Slots)
const AZ::BehaviorParameter* resultParameter = behaviorMethod->HasResult() ? behaviorMethod->GetResult() : nullptr;
if (resultParameter)
{
Argument result;
AZStd::string resultKey = resultParameter->m_typeId.ToString<AZStd::string>();
AZStd::string resultName = resultParameter->m_name;
AZStd::string resultDescription = "";
Helpers::GetTypeNameAndDescription(resultParameter->m_typeId, resultName, resultDescription);
result.m_typeId = resultKey;
result.m_details.m_name = resultParameter->m_name;
result.m_details.m_tooltip = resultDescription;
methodEntry.m_results.push_back(result);
}
}
void TranslationGeneration::TranslateBehaviorProperty(const AZ::BehaviorProperty* behaviorProperty, const AZStd::string& className, const AZStd::string& context, Entry* entry)
{
if (!behaviorProperty->m_getter && !behaviorProperty->m_setter)
{
return;
}
Entry localEntry;
if (!entry)
{
entry = &localEntry;
entry->m_key = className;
entry->m_context = context;
}
if (behaviorProperty->m_getter)
{
Method method;
auto methodName = behaviorProperty->m_getter->m_name;
method.m_key = behaviorProperty->m_name;
method.m_details.m_name = methodName;
method.m_details.m_tooltip = behaviorProperty->m_getter->m_debugDescription ? behaviorProperty->m_getter->m_debugDescription : "";
TranslateMethod(behaviorProperty->m_getter, method);
entry->m_methods.push_back(method);
}
if (behaviorProperty->m_setter)
{
Method method;
auto methodName = behaviorProperty->m_setter->m_name;
method.m_key = behaviorProperty->m_name;
method.m_details.m_name = methodName;
method.m_details.m_tooltip = behaviorProperty->m_setter->m_debugDescription ? behaviorProperty->m_getter->m_debugDescription : "";
TranslateMethod(behaviorProperty->m_setter, method);
entry->m_methods.push_back(method);
}
}
bool TranslationGeneration::TranslateEBusHandler(const AZ::BehaviorEBus* behaviorEbus, TranslationFormat& translationRoot)
{
// Must be a valid ebus handler
Gems/ScriptCanvas/Code/Tools/TranslationGeneration.h
+7 -1
View File
@@ -124,11 +124,17 @@ namespace ScriptCanvasEditorTools
//! Generates the translation data for all global properties and methods in the BehaviorContext
void TranslateBehaviorGlobals();
//! Generates the translation data for the specified property in the BehaviorContext
//! Generates the translation data for the specified property in the BehaviorContext (global, by name)
void TranslateBehaviorProperty(const AZStd::string& propertyName);
//! Generates the translation data for the specified property in the BehaviorContext
void TranslateBehaviorProperty(const AZ::BehaviorProperty* behaviorProperty, const AZStd::string& className, const AZStd::string& context, Entry* entry = nullptr);
private:
//! Utility to populate a BehaviorMethod's translation data
void TranslateMethod(AZ::BehaviorMethod* behaviorMethod, Method& methodEntry);
//! Generates the translation data for a BehaviorEBus that has an BehaviorEBusHandler
bool TranslateEBusHandler(const AZ::BehaviorEBus* behaviorEbus, TranslationFormat& translationRoot);