godot/doc/classes/ScriptEditorBase.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptEditorBase" inherits="VBoxContainer" version="4.0">
	<brief_description>
		Base editor for editing scripts in the [ScriptEditor].
	</brief_description>
	<description>
		Base editor for editing scripts in the [ScriptEditor], this does not include documentation items.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_syntax_highlighter">
			<return type="void" />
			<argument index="0" name="highlighter" type="EditorSyntaxHighlighter" />
			<description>
				Adds a [EditorSyntaxHighlighter] to the open script.
			</description>
		</method>
		<method name="get_base_editor" qualifiers="const">
			<return type="Control" />
			<description>
				Returns the underlying [Control] used for editing scripts. This can be either [CodeEdit] (for text scripts) or [GraphEdit] (for visual scripts).
			</description>
		</method>
	</methods>
	<signals>
		<signal name="edited_script_changed">
			<description>
				Emitted after script validation. For visual scripts on modification.
			</description>
		</signal>
		<signal name="go_to_help">
			<argument index="0" name="what" type="String" />
			<description>
				Emitted when the user requests a specific documentation page.
			</description>
		</signal>
		<signal name="name_changed">
			<description>
				Emitted after script validation or when the edited resource has changed. Not used by visual scripts.
			</description>
		</signal>
		<signal name="replace_in_files_requested">
			<argument index="0" name="text" type="String" />
			<description>
				Emitted when the user request to find and replace text in the file system. Not used by visual scripts.
			</description>
		</signal>
		<signal name="request_help">
			<argument index="0" name="topic" type="String" />
			<description>
				Emitted when the user requests contextual help.
			</description>
		</signal>
		<signal name="request_open_script_at_line">
			<argument index="0" name="script" type="Object" />
			<argument index="1" name="line" type="int" />
			<description>
				Emitted when the user requests a script.
			</description>
		</signal>
		<signal name="request_save_history">
			<description>
				Emitted when the user contextual goto and the item is in the same script.
			</description>
		</signal>
		<signal name="search_in_files_requested">
			<argument index="0" name="text" type="String" />
			<description>
				Emitted when the user request to search text in the file system. Not used by visual scripts.
			</description>
		</signal>
	</signals>
</class>
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
			`<class name="ScriptEditorBase" inherits="VBoxContainer" version="4.0">`
			`<brief_description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Base editor for editing scripts in the [ScriptEditor].`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</brief_description>`
			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Base editor for editing scripts in the [ScriptEditor], this does not include documentation items.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
Move add_syntax_highlighter bind to ScriptEditorBase 2021-10-12 01:13:31 +08:00			`<method name="add_syntax_highlighter">`
			`<return type="void" />`
			`<argument index="0" name="highlighter" type="EditorSyntaxHighlighter" />`
			`<description>`
			`Adds a [EditorSyntaxHighlighter] to the open script.`
			`</description>`
			`</method>`
Add get_base_editor to ScriptEditorBase 2021-05-14 03:50:25 +08:00			`<method name="get_base_editor" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Control" />`
Add get_base_editor to ScriptEditorBase 2021-05-14 03:50:25 +08:00			`<description>`
			`Returns the underlying [Control] used for editing scripts. This can be either [CodeEdit] (for text scripts) or [GraphEdit] (for visual scripts).`
			`</description>`
			`</method>`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</methods>`
			`<signals>`
			`<signal name="edited_script_changed">`
			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted after script validation. For visual scripts on modification.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="go_to_help">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<argument index="0" name="what" type="String" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted when the user requests a specific documentation page.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="name_changed">`
			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted after script validation or when the edited resource has changed. Not used by visual scripts.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="replace_in_files_requested">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<argument index="0" name="text" type="String" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted when the user request to find and replace text in the file system. Not used by visual scripts.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="request_help">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<argument index="0" name="topic" type="String" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted when the user requests contextual help.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="request_open_script_at_line">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<argument index="0" name="script" type="Object" />`
			`<argument index="1" name="line" type="int" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted when the user requests a script.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="request_save_history">`
			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted when the user contextual goto and the item is in the same script.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`<signal name="search_in_files_requested">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<argument index="0" name="text" type="String" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Emitted when the user request to search text in the file system. Not used by visual scripts.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</signal>`
			`</signals>`
			`</class>`