Skip to content

Commit 949cf04

Browse files
committed
Document @export_tool_button icon parameter in GDScript exports
1 parent 9924a69 commit 949cf04

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

tutorials/scripting/gdscript/gdscript_exports.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,21 @@ for a list of parameters and their allowed values.
494494
If you need to create a clickable inspector button, you can use ``@export_tool_button``.
495495
This exports a ``Callable`` property as a clickable button. When the button is pressed, the callable is called.
496496

497-
Export a button with label ``"Hello"`` and icon ``"Callable"``. When you press it, it will print ``"Hello world!"``.
497+
You can specify a custom icon name, which must match one of the icon
498+
file names from the
499+
`editor/icons <https://github.com/godotengine/godot/tree/master/editor/icons>`__
500+
folder of the Godot source repository (case-sensitive).
501+
You can also browse the editor icons using the
502+
`Godot editor icons <https://godot-editor-icons.github.io/>`__ website.
503+
504+
For example, if you wish to use ``Node2D.svg`` from that folder, you must
505+
specify ``"Node2D"`` as the second parameter of ``@export_tool_button``. It is
506+
not currently possible to use custom icons from the project folder; only
507+
built-in editor icons can be used.
508+
509+
This exports a button with label ``"Hello"`` and icon ``"Callable"`` (which is the
510+
default if no icon is specified). When you press it, it will print ``"Hello
511+
world!"``.
498512

499513
::
500514

0 commit comments

Comments
 (0)