Skip to content

Commit

Permalink
Document GDScript @export_tool_button (#10338)
Browse files Browse the repository at this point in the history
* Add @export_tool_button to the documention
  • Loading branch information
52SW authored Nov 29, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 94d266a commit e05cebe
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions tutorials/scripting/gdscript/gdscript_exports.rst
Original file line number Diff line number Diff line change
@@ -480,6 +480,24 @@ for a list of parameters and their allowed values.
When using ``@export_custom``, GDScript does not perform any validation on
the syntax. Invalid syntax may have unexpected behavior in the inspector.

``@export_tool_button``
-----------------------

If you need to create a clickable inspector button, you can use ``@export_tool_button``.
This exports a ``Callable`` property as a clickable button. When the button is pressed, the callable is called.

Export a button with label ``"Hello"`` and icon ``"Callable"``. When you press it, it will print ``"Hello world!"``.

::

@tool
extends Node

@export_tool_button("Hello", "Callable") var hello_action = hello

func hello():
print("Hello world!")

Setting exported variables from a tool script
---------------------------------------------

0 comments on commit e05cebe

Please sign in to comment.