godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Display enum value descriptions in the editor inspector help tooltips

Browse Source 
This makes it possible to see what each value does without having
to open a documentation tab.

Some enum value names may be mismatched as the API doesn't always
match the property hint used in the editor.
This commit is contained in:
Hugo Locurcio 2023-04-19 02:00:13 +02:00
parent 06f5b09ca4
commit 76c0a3fea0
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
editor/editor_inspector.cpp
View File

@ -3143,11 +3143,32 @@ void EditorInspector::update_tree() {
if (!found) { if (!found) {
// Build the property description String and add it to the cache. // Build the property description String and add it to the cache.
DocTools *dd = EditorHelp::get_doc_data(); DocTools *dd = EditorHelp::get_doc_data();
HashMap<String, DocData::ClassDoc>::Iterator F = dd->class_list.find(classname); HashMap<String, DocData::ClassDoc>::ConstIterator F = dd->class_list.find(classname);
while (F && doc_info.description.is_empty()) { while (F && doc_info.description.is_empty()) {
for (int i = 0; i < F->value.properties.size(); i++) { for (int i = 0; i < F->value.properties.size(); i++) {
if (F->value.properties[i].name == propname.operator String()) { if (F->value.properties[i].name == propname.operator String()) {
doc_info.description = DTR(F->value.properties[i].description); doc_info.description = DTR(F->value.properties[i].description);
const Vector<String> class_enum = F->value.properties[i].enumeration.split(".");
const String class_name = class_enum[0];
const String enum_name = class_enum.size() >= 2 ? class_enum[1] : "";
if (!enum_name.is_empty()) {
HashMap<String, DocData::ClassDoc>::ConstIterator enum_class = dd->class_list.find(class_name);
if (enum_class) {
for (DocData::ConstantDoc val : enum_class->value.constants) {
// Don't display `_MAX` enum value descriptions, as these are never exposed in the inspector.
if (val.enumeration == enum_name && !val.name.ends_with("_MAX")) {
const String enum_value = EditorPropertyNameProcessor::get_singleton()->process_name(val.name, EditorPropertyNameProcessor::STYLE_CAPITALIZED);
// Prettify the enum value display, so that "<ENUM NAME>_<VALUE>" becomes "Value".
doc_info.description += vformat(
"\n[b]%s:[/b] %s",
enum_value.trim_prefix(EditorPropertyNameProcessor::get_singleton()->process_name(enum_name, EditorPropertyNameProcessor::STYLE_CAPITALIZED) + " "),
DTR(val.description).trim_prefix("\n"));
}
}
}
}
doc_info.path = "class_property:" + F->value.name + ":" + F->value.properties[i].name; doc_info.path = "class_property:" + F->value.name + ":" + F->value.properties[i].name;
break; break;
} }