diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2022-12-02 03:04:23 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-02 03:04:23 +0300 |
| commit | bf9cf7d0346968ca482465ffb1fc2bf94f2ae877 (patch) | |
| tree | 6b5c328555fb4f8cc0016f085cfa0e612fc43585 | |
| parent | 1bd7b0b269bdda4659d957d90c623735a4c22408 (diff) | |
| parent | 369c7d2422d4d429618070e13d85b46c0ffbb1ea (diff) | |
Merge pull request #69166 from souplamp/icon-annotation-not-working
Update docs to clarify `@icon` only works with global script classes
| -rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index c8eda53a2d..4981750b7d 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -547,7 +547,7 @@ <return type="void" /> <param index="0" name="icon_path" type="String" /> <description> - Add a custom icon to the current script. After loading an icon at [param icon_path], the icon is displayed in the Scene dock for every node that the script is attached to. For named classes, the icon is also displayed in various editor dialogs. + 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. [codeblock] @icon("res://path/to/class/icon.svg") [/codeblock] |