summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-09-29 00:46:55 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-09-29 00:46:55 +0200
commita11f970f91f8e049501d2077a3de3fba26bba1ba (patch)
treefa5f8580b3b581d65828800c5e98805d0a97632d /doc
parentd6c0509b5a7f746b06d06b03b1bce10fcd7a047c (diff)
parent85dfd896536ff04dba4afd7d461a28e0ac4b9aee (diff)
downloadredot-engine-a11f970f91f8e049501d2077a3de3fba26bba1ba.tar.gz
Merge pull request #96290 from Macksaur/export-action-callable
Add `@export_tool_button` annotation for easily creating inspector buttons.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/@GlobalScope.xml10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index a86f41cd9c..63d20242d6 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -2933,7 +2933,15 @@
<constant name="PROPERTY_HINT_PASSWORD" value="36" enum="PropertyHint">
Hints that a string property is a password, and every character is replaced with the secret character.
</constant>
- <constant name="PROPERTY_HINT_MAX" value="39" enum="PropertyHint">
+ <constant name="PROPERTY_HINT_TOOL_BUTTON" value="39" enum="PropertyHint">
+ Hints that a [Callable] property should be displayed as a clickable button. When the button is pressed, the callable is called. The hint string specifies the button text and optionally an icon from the [code]"EditorIcons"[/code] theme type.
+ [codeblock lang=text]
+ "Click me!" - A button with the text "Click me!" and the default "Callable" icon.
+ "Click me!,ColorRect" - A button with the text "Click me!" and the "ColorRect" icon.
+ [/codeblock]
+ [b]Note:[/b] A [Callable] cannot be properly serialized and stored in a file, so it is recommended to use [constant PROPERTY_USAGE_EDITOR] instead of [constant PROPERTY_USAGE_DEFAULT].
+ </constant>
+ <constant name="PROPERTY_HINT_MAX" value="40" enum="PropertyHint">
Represents the size of the [enum PropertyHint] enum.
</constant>
<constant name="PROPERTY_USAGE_NONE" value="0" enum="PropertyUsageFlags" is_bitfield="true">