Browse Source

Merge pull request #92916 from Naros/expose-update-docs-from-script

Expose `update_docs_from_script` method
Rémi Verschelde 11 months ago
parent
commit
f5bf9b60bd
2 changed files with 9 additions and 0 deletions
  1. 8 0
      doc/classes/ScriptEditor.xml
  2. 1 0
      editor/plugins/script_editor_plugin.cpp

+ 8 - 0
doc/classes/ScriptEditor.xml

@@ -99,6 +99,14 @@
 				[b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
 			</description>
 		</method>
+		<method name="update_docs_from_script">
+			<return type="void" />
+			<param index="0" name="script" type="Script" />
+			<description>
+				Updates the documentation for the given [param script] if the script's documentation is currently open.
+				[b]Note:[/b] This should be called whenever the script is changed to keep the open documentation state up to date.
+			</description>
+		</method>
 	</methods>
 	<signals>
 		<signal name="editor_script_changed">

+ 1 - 0
editor/plugins/script_editor_plugin.cpp

@@ -4058,6 +4058,7 @@ void ScriptEditor::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("open_script_create_dialog", "base_name", "base_path"), &ScriptEditor::open_script_create_dialog);
 
 	ClassDB::bind_method(D_METHOD("goto_help", "topic"), &ScriptEditor::goto_help);
+	ClassDB::bind_method(D_METHOD("update_docs_from_script", "script"), &ScriptEditor::update_docs_from_script);
 
 	ADD_SIGNAL(MethodInfo("editor_script_changed", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
 	ADD_SIGNAL(MethodInfo("script_close", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));