godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ScriptEditorBase.xml

77 lines
2.5 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptEditorBase" inherits="VBoxContainer" version="4.0">
<brief_description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Base editor for editing scripts in the [ScriptEditor].
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</brief_description>
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Base editor for editing scripts in the [ScriptEditor], this does not include documentation items.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Consistently prefix bound virtual methods with _
2021-05-15 21:48:59 +00:00
<method name="_add_syntax_highlighter" qualifiers="virtual">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="highlighter" type="Object" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Adds a [EditorSyntaxHighlighter] to the open script.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
</method>
Add get_base_editor to ScriptEditorBase
2021-05-13 19:50:25 +00: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 13:28:05 +00:00
<return type="Control" />
Add get_base_editor to ScriptEditorBase
2021-05-13 19:50:25 +00: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 06:43:21 +00:00
</methods>
<signals>
<signal name="edited_script_changed">
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Emitted after script validation. For visual scripts on modification.
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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 13:28:05 +00:00
<argument index="0" name="what" type="String" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Emitted when the user requests a specific documentation page.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
</signal>
<signal name="name_changed">
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00: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 06:43:21 +00: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 13:28:05 +00:00
<argument index="0" name="text" type="String" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00: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 06:43:21 +00: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 13:28:05 +00:00
<argument index="0" name="topic" type="String" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Emitted when the user requests contextual help.
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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 13:28:05 +00:00
<argument index="0" name="script" type="Object" />
<argument index="1" name="line" type="int" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Emitted when the user requests a script.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
</signal>
<signal name="request_save_history">
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Emitted when the user contextual goto and the item is in the same script.
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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 13:28:05 +00:00
<argument index="0" name="text" type="String" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00: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 06:43:21 +00:00
</description>
</signal>
</signals>
<constants>
</constants>
</class>