mirror of
https://github.com/godotengine/godot
synced 2024-09-05 11:38:33 +00:00
Add a script method to get its class icon
Co-authored-by: Danil Alexeev <danil@alexeev.xyz>
This commit is contained in:
parent
6758a7f8c0
commit
2c77f07aaa
|
@ -141,6 +141,7 @@ public:
|
||||||
|
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
virtual Vector<DocData::ClassDoc> get_documentation() const = 0;
|
virtual Vector<DocData::ClassDoc> get_documentation() const = 0;
|
||||||
|
virtual String get_class_icon_path() const = 0;
|
||||||
virtual PropertyInfo get_class_category() const;
|
virtual PropertyInfo get_class_category() const;
|
||||||
#endif // TOOLS_ENABLED
|
#endif // TOOLS_ENABLED
|
||||||
|
|
||||||
|
|
|
@ -52,6 +52,7 @@ void ScriptExtension::_bind_methods() {
|
||||||
GDVIRTUAL_BIND(_reload, "keep_state");
|
GDVIRTUAL_BIND(_reload, "keep_state");
|
||||||
|
|
||||||
GDVIRTUAL_BIND(_get_documentation);
|
GDVIRTUAL_BIND(_get_documentation);
|
||||||
|
GDVIRTUAL_BIND(_get_class_icon_path);
|
||||||
|
|
||||||
GDVIRTUAL_BIND(_has_method, "method");
|
GDVIRTUAL_BIND(_has_method, "method");
|
||||||
GDVIRTUAL_BIND(_get_method_info, "method");
|
GDVIRTUAL_BIND(_get_method_info, "method");
|
||||||
|
|
|
@ -77,6 +77,7 @@ public:
|
||||||
EXBIND1R(Error, reload, bool)
|
EXBIND1R(Error, reload, bool)
|
||||||
|
|
||||||
GDVIRTUAL0RC(TypedArray<Dictionary>, _get_documentation)
|
GDVIRTUAL0RC(TypedArray<Dictionary>, _get_documentation)
|
||||||
|
GDVIRTUAL0RC(String, _get_class_icon_path)
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
virtual Vector<DocData::ClassDoc> get_documentation() const override {
|
virtual Vector<DocData::ClassDoc> get_documentation() const override {
|
||||||
TypedArray<Dictionary> doc;
|
TypedArray<Dictionary> doc;
|
||||||
|
@ -89,6 +90,12 @@ public:
|
||||||
|
|
||||||
return class_doc;
|
return class_doc;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
virtual String get_class_icon_path() const override {
|
||||||
|
String ret;
|
||||||
|
GDVIRTUAL_CALL(_get_class_icon_path, ret);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
#endif // TOOLS_ENABLED
|
#endif // TOOLS_ENABLED
|
||||||
|
|
||||||
EXBIND1RC(bool, has_method, const StringName &)
|
EXBIND1RC(bool, has_method, const StringName &)
|
||||||
|
|
|
@ -22,6 +22,11 @@
|
||||||
<description>
|
<description>
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
|
<method name="_get_class_icon_path" qualifiers="virtual const">
|
||||||
|
<return type="String" />
|
||||||
|
<description>
|
||||||
|
</description>
|
||||||
|
</method>
|
||||||
<method name="_get_constants" qualifiers="virtual const">
|
<method name="_get_constants" qualifiers="virtual const">
|
||||||
<return type="Dictionary" />
|
<return type="Dictionary" />
|
||||||
<description>
|
<description>
|
||||||
|
|
|
@ -1122,8 +1122,14 @@ Ref<Texture2D> EditorData::get_script_icon(const Ref<Script> &p_script) {
|
||||||
Ref<Script> base_scr = p_script;
|
Ref<Script> base_scr = p_script;
|
||||||
while (base_scr.is_valid()) {
|
while (base_scr.is_valid()) {
|
||||||
// Check for scripted classes.
|
// Check for scripted classes.
|
||||||
|
String icon_path;
|
||||||
StringName class_name = script_class_get_name(base_scr->get_path());
|
StringName class_name = script_class_get_name(base_scr->get_path());
|
||||||
String icon_path = script_class_get_icon_path(class_name);
|
if (base_scr->is_built_in() || class_name == StringName()) {
|
||||||
|
icon_path = base_scr->get_class_icon_path();
|
||||||
|
} else {
|
||||||
|
icon_path = script_class_get_icon_path(class_name);
|
||||||
|
}
|
||||||
|
|
||||||
Ref<Texture2D> icon = _load_script_icon(icon_path);
|
Ref<Texture2D> icon = _load_script_icon(icon_path);
|
||||||
if (icon.is_valid()) {
|
if (icon.is_valid()) {
|
||||||
_script_icon_cache[p_script] = icon;
|
_script_icon_cache[p_script] = icon;
|
||||||
|
|
|
@ -3457,7 +3457,7 @@ void EditorNode::_remove_edited_scene(bool p_change_tab) {
|
||||||
|
|
||||||
void EditorNode::_remove_scene(int index, bool p_change_tab) {
|
void EditorNode::_remove_scene(int index, bool p_change_tab) {
|
||||||
// Clear icon cache in case some scripts are no longer needed.
|
// Clear icon cache in case some scripts are no longer needed.
|
||||||
// FIXME: Perfectly the cache should never be cleared and only updated on per-script basis, when an icon changes.
|
// FIXME: Ideally the cache should never be cleared and only updated on per-script basis, when an icon changes.
|
||||||
editor_data.clear_script_icon_cache();
|
editor_data.clear_script_icon_cache();
|
||||||
|
|
||||||
if (editor_data.get_edited_scene() == index) {
|
if (editor_data.get_edited_scene() == index) {
|
||||||
|
|
|
@ -595,7 +595,7 @@
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<param index="0" name="icon_path" type="String" />
|
<param index="0" name="icon_path" type="String" />
|
||||||
<description>
|
<description>
|
||||||
Add a custom icon to the current script. The script must be registered as a global class using the [code]class_name[/code] keyword for this to have a visible effect. The icon specified at [param icon_path] is displayed in the Scene dock for every node of that class, as well as in various editor dialogs.
|
Add a custom icon to the current script. The icon specified at [param icon_path] is displayed in the Scene dock for every node of that class, as well as in various editor dialogs.
|
||||||
[codeblock]
|
[codeblock]
|
||||||
@icon("res://path/to/class/icon.svg")
|
@icon("res://path/to/class/icon.svg")
|
||||||
[/codeblock]
|
[/codeblock]
|
||||||
|
|
|
@ -482,6 +482,10 @@ void GDScript::_clear_doc() {
|
||||||
docs.clear();
|
docs.clear();
|
||||||
doc = DocData::ClassDoc();
|
doc = DocData::ClassDoc();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
String GDScript::get_class_icon_path() const {
|
||||||
|
return simplified_icon_path;
|
||||||
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
bool GDScript::_update_exports(bool *r_err, bool p_recursive_call, PlaceHolderScriptInstance *p_instance_to_update) {
|
bool GDScript::_update_exports(bool *r_err, bool p_recursive_call, PlaceHolderScriptInstance *p_instance_to_update) {
|
||||||
|
@ -2527,13 +2531,6 @@ String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_b
|
||||||
* Before changing this function, please ask the current maintainer of EditorFileSystem.
|
* Before changing this function, please ask the current maintainer of EditorFileSystem.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
if (r_icon_path) {
|
|
||||||
if (c->icon_path.is_empty() || c->icon_path.is_absolute_path()) {
|
|
||||||
*r_icon_path = c->icon_path.simplify_path();
|
|
||||||
} else if (c->icon_path.is_relative_path()) {
|
|
||||||
*r_icon_path = p_path.get_base_dir().path_join(c->icon_path).simplify_path();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (r_base_type) {
|
if (r_base_type) {
|
||||||
const GDScriptParser::ClassNode *subclass = c;
|
const GDScriptParser::ClassNode *subclass = c;
|
||||||
String path = p_path;
|
String path = p_path;
|
||||||
|
@ -2601,6 +2598,9 @@ String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_b
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (r_icon_path) {
|
||||||
|
*r_icon_path = c->simplified_icon_path;
|
||||||
|
}
|
||||||
return c->identifier != nullptr ? String(c->identifier->name) : String();
|
return c->identifier != nullptr ? String(c->identifier->name) : String();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -144,6 +144,7 @@ class GDScript : public Script {
|
||||||
String path;
|
String path;
|
||||||
String name;
|
String name;
|
||||||
String fully_qualified_name;
|
String fully_qualified_name;
|
||||||
|
String simplified_icon_path;
|
||||||
SelfList<GDScript> script_list;
|
SelfList<GDScript> script_list;
|
||||||
|
|
||||||
SelfList<GDScriptFunctionState>::List pending_func_states;
|
SelfList<GDScriptFunctionState>::List pending_func_states;
|
||||||
|
@ -250,6 +251,7 @@ public:
|
||||||
virtual Vector<DocData::ClassDoc> get_documentation() const override {
|
virtual Vector<DocData::ClassDoc> get_documentation() const override {
|
||||||
return docs;
|
return docs;
|
||||||
}
|
}
|
||||||
|
virtual String get_class_icon_path() const override;
|
||||||
#endif // TOOLS_ENABLED
|
#endif // TOOLS_ENABLED
|
||||||
|
|
||||||
virtual Error reload(bool p_keep_state = false) override;
|
virtual Error reload(bool p_keep_state = false) override;
|
||||||
|
|
|
@ -2928,6 +2928,7 @@ void GDScriptCompiler::convert_to_initializer_type(Variant &p_variant, const GDS
|
||||||
void GDScriptCompiler::make_scripts(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state) {
|
void GDScriptCompiler::make_scripts(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state) {
|
||||||
p_script->fully_qualified_name = p_class->fqcn;
|
p_script->fully_qualified_name = p_class->fqcn;
|
||||||
p_script->name = p_class->identifier ? p_class->identifier->name : "";
|
p_script->name = p_class->identifier ? p_class->identifier->name : "";
|
||||||
|
p_script->simplified_icon_path = p_class->simplified_icon_path;
|
||||||
|
|
||||||
HashMap<StringName, Ref<GDScript>> old_subclasses;
|
HashMap<StringName, Ref<GDScript>> old_subclasses;
|
||||||
|
|
||||||
|
|
|
@ -3836,18 +3836,31 @@ bool GDScriptParser::tool_annotation(const AnnotationNode *p_annotation, Node *p
|
||||||
bool GDScriptParser::icon_annotation(const AnnotationNode *p_annotation, Node *p_node) {
|
bool GDScriptParser::icon_annotation(const AnnotationNode *p_annotation, Node *p_node) {
|
||||||
ERR_FAIL_COND_V_MSG(p_node->type != Node::CLASS, false, R"("@icon" annotation can only be applied to classes.)");
|
ERR_FAIL_COND_V_MSG(p_node->type != Node::CLASS, false, R"("@icon" annotation can only be applied to classes.)");
|
||||||
ERR_FAIL_COND_V(p_annotation->resolved_arguments.is_empty(), false);
|
ERR_FAIL_COND_V(p_annotation->resolved_arguments.is_empty(), false);
|
||||||
|
|
||||||
ClassNode *p_class = static_cast<ClassNode *>(p_node);
|
ClassNode *p_class = static_cast<ClassNode *>(p_node);
|
||||||
|
String path = p_annotation->resolved_arguments[0];
|
||||||
|
|
||||||
#ifdef DEBUG_ENABLED
|
#ifdef DEBUG_ENABLED
|
||||||
if (!p_class->icon_path.is_empty()) {
|
if (!p_class->icon_path.is_empty()) {
|
||||||
push_error(R"("@icon" annotation can only be used once.)", p_annotation);
|
push_error(R"("@icon" annotation can only be used once.)", p_annotation);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if (String(p_annotation->resolved_arguments[0]).is_empty()) {
|
if (path.is_empty()) {
|
||||||
push_error(R"("@icon" annotation argument must contain the path to the icon.)", p_annotation->arguments[0]);
|
push_error(R"("@icon" annotation argument must contain the path to the icon.)", p_annotation->arguments[0]);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
#endif // DEBUG_ENABLED
|
#endif // DEBUG_ENABLED
|
||||||
p_class->icon_path = p_annotation->resolved_arguments[0];
|
|
||||||
|
p_class->icon_path = path;
|
||||||
|
|
||||||
|
if (path.is_empty() || path.is_absolute_path()) {
|
||||||
|
p_class->simplified_icon_path = path.simplify_path();
|
||||||
|
} else if (path.is_relative_path()) {
|
||||||
|
p_class->simplified_icon_path = script_path.get_base_dir().path_join(path).simplify_path();
|
||||||
|
} else {
|
||||||
|
p_class->simplified_icon_path = path;
|
||||||
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -724,6 +724,7 @@ public:
|
||||||
|
|
||||||
IdentifierNode *identifier = nullptr;
|
IdentifierNode *identifier = nullptr;
|
||||||
String icon_path;
|
String icon_path;
|
||||||
|
String simplified_icon_path;
|
||||||
Vector<Member> members;
|
Vector<Member> members;
|
||||||
HashMap<StringName, int> members_indices;
|
HashMap<StringName, int> members_indices;
|
||||||
ClassNode *outer = nullptr;
|
ClassNode *outer = nullptr;
|
||||||
|
|
|
@ -164,6 +164,9 @@ public:
|
||||||
Vector<DocData::ClassDoc> docs;
|
Vector<DocData::ClassDoc> docs;
|
||||||
return docs;
|
return docs;
|
||||||
}
|
}
|
||||||
|
virtual String get_class_icon_path() const override {
|
||||||
|
return icon_path;
|
||||||
|
}
|
||||||
#endif // TOOLS_ENABLED
|
#endif // TOOLS_ENABLED
|
||||||
|
|
||||||
Error reload(bool p_keep_state = false) override;
|
Error reload(bool p_keep_state = false) override;
|
||||||
|
|
Loading…
Reference in a new issue