Add `@tool_button` annotation for easily creating inspector buttons. #78355

fire · 2023-06-17T04:22:46Z

Supersedes: #59289
Closes: godotengine/godot-proposals#2149

I see you replaced UndoRedo with EditorUndoRedoManager in response to my comment. Unfortunately it won't work, because all actions should go through EditorUndoRedoManager.
Need to test api changes

dalexeev · 2023-06-20T11:20:41Z

TOOL_BUTTON as well as GROUP should be a "pseudo member" and must not shadow real members in members_indices, see #78254. In property list the names should be different too, I think (unlike GROUP).

To change the order of a tool button in the inspector, are you forced to move the function up? This does not follow the GDScript style guide, which recommends that variables be placed above functions.

YuriSizov · 2023-06-20T11:31:42Z

To change the order of a tool button in the inspector, are you forced to move the function up? This does not follow the GDScript style guide, which recommends that variables be placed above functions.

The last time we discussed the syntax it was suggested that you can add the annotation wherever you want if you pass a callable "reference" to it, see #59289 (comment).

fire · 2023-06-20T18:06:44Z

Can you explain how this affects this pr? Like how to change?

AThousandShips · 2023-08-17T08:24:23Z

editor/plugins/tool_button_editor_plugin.h

+	ToolButtonEditorPlugin();
+};
+
+#endif // TOOL_BUTTON_EDITOR_PLUGIN_H


Missing line termination

fire · 2023-08-18T18:19:28Z

Can someone help me test this? Also, does anyone know how to call this feature from c++?

AThousandShips · 2023-08-24T16:58:33Z

modules/gdscript/gdscript_parser.cpp

@@ -4174,6 +4178,44 @@ bool GDScriptParser::warning_annotations(const AnnotationNode *p_annotation, Nod
 #endif // DEBUG_ENABLED
 }

+bool GDScriptParser::tool_button_annotation(const AnnotationNode *p_annotation, Node *p_node) {
+#ifndef TOOLS_ENABLED // !TOOLS_ENABLED


I'd flip the condition here, with both cases having the negative condition first is confusing

Calinou · 2024-02-23T17:50:37Z

modules/gdscript/doc_classes/@GDScript.xml

+				func reset_color(old_color):
+				    modulate = old_color
+				[/codeblock]
+				[b]Note:[/b] Make sure to provide separate `do` and `undo` methods that perform and reverse the action respectively.


Suggested change

[b]Note:[/b] Make sure to provide separate `do` and `undo` methods that perform and reverse the action respectively.

[b]Note:[/b] Make sure to provide separate [code]do[/code] and [code]undo[/code] methods that perform and reverse the action respectively.

Also, this code sample won't work as-is because set_color and reset_color should be called do_method_name and undo_method_name for this example respectively.

AThousandShips · 2024-02-23T10:53:48Z

editor/plugins/tool_button_editor_plugin.cpp

+/**************************************************************************/
+
+#include "tool_button_editor_plugin.h"
+#include "editor/editor_node.h"


Suggested change

#include "editor/editor_node.h"

#include "editor/editor_node.h"

AThousandShips · 2024-02-23T10:54:23Z

editor/plugins/tool_button_editor_plugin.h

+	virtual bool can_handle(Object *p_object) override;
+	virtual bool parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField<PropertyUsageFlags> p_usage, const bool p_wide = false) override;
+	void update_action_icon(Button *p_action_button);
+	void call_action(Object *p_object, StringName p_do_method_name, StringName p_undo_method_name);


Suggested change

void call_action(Object *p_object, StringName p_do_method_name, StringName p_undo_method_name);

void call_action(Object *p_object, const StringName &p_do_method_name, const StringName &p_undo_method_name);

AThousandShips · 2024-02-23T17:52:53Z

modules/gdscript/gdscript_parser.cpp

+#ifndef TOOLS_ENABLED // !TOOLS_ENABLED
+	// Only available in editor.
+	return true;
+#else // TOOLS_ENABLED
+	AnnotationNode *annotation = const_cast<AnnotationNode *>(p_annotation);
+	FunctionNode *func = static_cast<FunctionNode *>(p_node);
+	if (annotation->resolved_arguments.size() < 1) {
+		push_error("Tool buttons must specify a name.", p_annotation);
+		return false;
+	}
+
+	if (!this->is_tool()) {
+		push_error("Tool buttons can only be used in tool scripts.", p_annotation);
+		return false;
+	}
+
+	annotation->export_info.name = annotation->resolved_arguments[0];
+	annotation->export_info.type = Variant::Type::CALLABLE;
+	annotation->export_info.usage = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_INTERNAL;
+	if (func->parameters.size() != 1) {
+		push_error("Tool button methods must have an UndoRedo as their only argument.", func);
+		return false;
+	}
+	if (func->parameters[0]->datatype_specifier != nullptr && func->parameters[0]->datatype_specifier->type_chain[0]->name != "UndoRedo") {
+		push_error("Tool button methods must have an UndoRedo as their only argument.", func);
+		return false;
+	}
+	String hint_string = vformat("%s,%s", annotation->resolved_arguments[0], func->identifier->name);
+	if (annotation->resolved_arguments.size() > 1) {
+		// Icon.
+		hint_string += "," + annotation->resolved_arguments[1].operator String();
+	}
+	annotation->export_info.hint_string = hint_string;
+	return true;
+#endif // TOOLS_ENABLED


Suggested change

#ifndef TOOLS_ENABLED // !TOOLS_ENABLED

// Only available in editor.

return true;

#else // TOOLS_ENABLED

AnnotationNode *annotation = const_cast<AnnotationNode *>(p_annotation);

FunctionNode *func = static_cast<FunctionNode *>(p_node);

if (annotation->resolved_arguments.size() < 1) {

push_error("Tool buttons must specify a name.", p_annotation);

return false;

}

if (!this->is_tool()) {

push_error("Tool buttons can only be used in tool scripts.", p_annotation);

return false;

}

annotation->export_info.name = annotation->resolved_arguments[0];

annotation->export_info.type = Variant::Type::CALLABLE;

annotation->export_info.usage = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_INTERNAL;

if (func->parameters.size() != 1) {

push_error("Tool button methods must have an UndoRedo as their only argument.", func);

return false;

}

if (func->parameters[0]->datatype_specifier != nullptr && func->parameters[0]->datatype_specifier->type_chain[0]->name != "UndoRedo") {

push_error("Tool button methods must have an UndoRedo as their only argument.", func);

return false;

}

String hint_string = vformat("%s,%s", annotation->resolved_arguments[0], func->identifier->name);

if (annotation->resolved_arguments.size() > 1) {

// Icon.

hint_string += "," + annotation->resolved_arguments[1].operator String();

}

annotation->export_info.hint_string = hint_string;

return true;

#endif // TOOLS_ENABLED

#ifdef TOOLS_ENABLED

AnnotationNode *annotation = const_cast<AnnotationNode *>(p_annotation);

FunctionNode *func = static_cast<FunctionNode *>(p_node);

if (annotation->resolved_arguments.size() < 1) {

push_error("Tool buttons must specify a name.", p_annotation);

return false;

}

if (!this->is_tool()) {

push_error("Tool buttons can only be used in tool scripts.", p_annotation);

return false;

}

annotation->export_info.name = annotation->resolved_arguments[0];

annotation->export_info.type = Variant::Type::CALLABLE;

annotation->export_info.usage = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_INTERNAL;

if (func->parameters.size() != 1) {

push_error("Tool button methods must have an UndoRedo as their only argument.", func);

return false;

}

if (func->parameters[0]->datatype_specifier != nullptr && func->parameters[0]->datatype_specifier->type_chain[0]->name != "UndoRedo") {

push_error("Tool button methods must have an UndoRedo as their only argument.", func);

return false;

}

String hint_string = vformat("%s,%s", annotation->resolved_arguments[0], func->identifier->name);

if (annotation->resolved_arguments.size() > 1) {

// Icon.

hint_string += "," + annotation->resolved_arguments[1].operator String();

}

annotation->export_info.hint_string = hint_string;

return true;

#else // !TOOLS_ENABLED

// Only available in editor.

return true;

#endif // TOOLS_ENABLED

As per the earlier suggestion

caphindsight · 2024-03-23T18:30:21Z

Is this still on track to make 4.3?

AThousandShips · 2024-03-23T18:32:13Z

It's been abandoned by the author and needs to be salvaged, so it's waiting for someone to pick it up and continue the work

caphindsight · 2024-03-24T08:42:52Z

I might be insterested in picking it up.

Can you please summarize for me why the (arguably, overcomplicated) design with do/undo was chosen?
For my use cases, these actions I want @tool_button to perform are approximately never easily undo-able.
For example, I'd have a build_mesh action which would start by dropping the old mesh, and just building a new one instead, etc.

Wouldn't it be much simpler and more user-friendly to give up on undo?

@export var mesh_parameter: int = 42

@tool_button("Build mesh.")
func build_mesh():
    # Use mesh_parameter here, no function arguments allowed

This is exactly what people use the "boolean hack" for these days, only nicer and without the ugly workaround code.

TokisanGames · 2024-03-24T09:05:32Z

Undo/redo functionality would be used by a plugin or tool developer. Click an inspector button to process the mesh. Oops, undo. The tool developer has the option to connect their do and undo functions so the action gets logged in Godot's history and users can use them. It should also give the developer the option of providing a null undo callback so the functionality can be ignored by devs making hacks for their own use, IMO. But then these folks don't really need a tool button, as the boolean hack will suffice.

Pshy0 · 2024-03-24T11:39:49Z

This feature could be added without undo/redo concerns by using a confirm dialogue.

ultrasuperpingu · 2024-04-10T15:46:11Z

Undo/redo functionality would be used by a plugin or tool developer.

I'm not sure to understand why plugin or tool developper can't use the regular UndoRedo class to implements this if they need it ? (In fact, I use the EditorUndoRedoManager but never the regular UndoRedo, so maybe I miss something)

TokisanGames · 2024-04-10T16:11:54Z

You can. You're going to provide do and undo functions either way. This uses undo/redo in the background, so it's just more concise, syntactic sugar.

ultrasuperpingu · 2024-04-10T16:25:28Z

You can. You're going to provide do and undo functions either way. This uses undo/redo in the background, so it's just more concise, syntactic sugar.

Then, IMHO it's not a good idea to make "regular" user to have to provide a null undo callback as they probably would be the main users of this feature... On my addons, I'm personally not really bothered to have to use a specific UndoRedo API to handle this pretty advanced feature (and for now, I mainly used an EditorPlugin, EditorNode3DPlugin and EditorNode3DGizmoPlugin to perform undoable actions).

KoBeWi · 2024-06-18T10:48:27Z

I think the solution for undoredo problems is just exposing EditorUndoRedoManager via EditorInterface (which is accessible as a singleton). This way the users would be able to optionally provide undo for their action, without making button callbacks more complex. I'm already exposing it in #90130.

Macksaur · 2024-08-29T17:02:55Z

I salvaged the great work here in #96290 to fit my use-cases. If anyone would like to check it out and let me know if I've missed any obvious wins, that'd be swell.

AThousandShips · 2024-08-29T17:06:17Z

Superseded by:

Add @export_tool_button annotation for easily creating inspector buttons. #96290

fire added this to the 4.2 milestone Jun 17, 2023

fire force-pushed the export-action-callable branch 4 times, most recently from fc69175 to 7ecec2a Compare June 17, 2023 04:46

YeldhamDev added feature proposal topic:gdscript topic:editor labels Jun 18, 2023

fire force-pushed the export-action-callable branch from 7ecec2a to 514e37e Compare August 17, 2023 05:13

Add @tool_button annotation for easily creating inspector buttons.

8f0330a

fire force-pushed the export-action-callable branch from 514e37e to 8f0330a Compare August 17, 2023 05:20

AThousandShips reviewed Aug 17, 2023

View reviewed changes

akien-mga mentioned this pull request Aug 17, 2023

Add @tool_button annotation for easily creating inspector buttons. #59289

Closed

YuriSizov self-requested a review August 24, 2023 11:56

AThousandShips reviewed Aug 24, 2023

View reviewed changes

YuriSizov modified the milestones: 4.2, 4.3 Sep 27, 2023

fire added the salvageable label Nov 7, 2023

This comment was marked as off-topic.

Sign in to view

Calinou reviewed Feb 23, 2024

View reviewed changes

AThousandShips reviewed Feb 23, 2024

View reviewed changes

greenfox1505 mentioned this pull request Mar 4, 2024

replaces build bool with buttons QodotPlugin/Qodot#152

Merged

lostminds mentioned this pull request May 19, 2024

VideoStreamPlayer not drawing anything when stopped, including not showing in editor #92050

Open

dalexeev modified the milestones: 4.3, 4.4 May 31, 2024

Flynsarmy mentioned this pull request Jun 5, 2024

Make adding AnimationMixer libraries more intuitive godotengine/godot-proposals#9893

Closed

AdriaandeJongh mentioned this pull request Jun 18, 2024

Expose run() method of EditorScript #93274

Open

KoBeWi mentioned this pull request Jun 28, 2024

Expose EditorUndoRedoManager's clear_history() #90130

Merged

Macksaur mentioned this pull request Aug 29, 2024

Add @export_tool_button annotation for easily creating inspector buttons. #96290

Merged

AThousandShips removed the salvageable label Aug 29, 2024

AThousandShips closed this Aug 29, 2024

AThousandShips added the archived label Aug 29, 2024

AThousandShips removed this from the 4.4 milestone Aug 29, 2024

fire deleted the export-action-callable branch August 29, 2024 17:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `@tool_button` annotation for easily creating inspector buttons. #78355

Add `@tool_button` annotation for easily creating inspector buttons. #78355

fire commented Jun 17, 2023 •

edited

Loading

dalexeev commented Jun 20, 2023

YuriSizov commented Jun 20, 2023

fire commented Jun 20, 2023 •

edited

Loading

AThousandShips Aug 17, 2023

fire commented Aug 18, 2023

AThousandShips Aug 24, 2023

This comment was marked as off-topic.

This comment was marked as off-topic.

Calinou Feb 23, 2024 •

edited

Loading

AThousandShips Feb 23, 2024

AThousandShips Feb 23, 2024

AThousandShips Feb 23, 2024

caphindsight commented Mar 23, 2024

AThousandShips commented Mar 23, 2024 •

edited

Loading

caphindsight commented Mar 24, 2024

TokisanGames commented Mar 24, 2024

Pshy0 commented Mar 24, 2024

ultrasuperpingu commented Apr 10, 2024 •

edited

Loading

TokisanGames commented Apr 10, 2024

ultrasuperpingu commented Apr 10, 2024 •

edited

Loading

KoBeWi commented Jun 18, 2024

Macksaur commented Aug 29, 2024

AThousandShips commented Aug 29, 2024

	[b]Note:[/b] Make sure to provide separate `do` and `undo` methods that perform and reverse the action respectively.
	[b]Note:[/b] Make sure to provide separate [code]do[/code] and [code]undo[/code] methods that perform and reverse the action respectively.

	#include "editor/editor_node.h"

	#include "editor/editor_node.h"

	void call_action(Object *p_object, StringName p_do_method_name, StringName p_undo_method_name);
	void call_action(Object *p_object, const StringName &p_do_method_name, const StringName &p_undo_method_name);

Add @tool_button annotation for easily creating inspector buttons. #78355

Add @tool_button annotation for easily creating inspector buttons. #78355

Conversation

fire commented Jun 17, 2023 • edited Loading

dalexeev commented Jun 20, 2023

YuriSizov commented Jun 20, 2023

fire commented Jun 20, 2023 • edited Loading

AThousandShips Aug 17, 2023

Choose a reason for hiding this comment

fire commented Aug 18, 2023

AThousandShips Aug 24, 2023

Choose a reason for hiding this comment

This comment was marked as off-topic.

This comment was marked as off-topic.

Calinou Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

AThousandShips Feb 23, 2024

Choose a reason for hiding this comment

AThousandShips Feb 23, 2024

Choose a reason for hiding this comment

AThousandShips Feb 23, 2024

Choose a reason for hiding this comment

caphindsight commented Mar 23, 2024

AThousandShips commented Mar 23, 2024 • edited Loading

caphindsight commented Mar 24, 2024

TokisanGames commented Mar 24, 2024

Pshy0 commented Mar 24, 2024

ultrasuperpingu commented Apr 10, 2024 • edited Loading

TokisanGames commented Apr 10, 2024

ultrasuperpingu commented Apr 10, 2024 • edited Loading

KoBeWi commented Jun 18, 2024

Macksaur commented Aug 29, 2024

AThousandShips commented Aug 29, 2024

Add `@tool_button` annotation for easily creating inspector buttons. #78355

Add `@tool_button` annotation for easily creating inspector buttons. #78355

fire commented Jun 17, 2023 •

edited

Loading

fire commented Jun 20, 2023 •

edited

Loading

Calinou Feb 23, 2024 •

edited

Loading

AThousandShips commented Mar 23, 2024 •

edited

Loading

ultrasuperpingu commented Apr 10, 2024 •

edited

Loading

ultrasuperpingu commented Apr 10, 2024 •

edited

Loading