diff options
Diffstat (limited to 'doc/classes/ScriptEditorBase.xml')
| -rw-r--r-- | doc/classes/ScriptEditorBase.xml | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/doc/classes/ScriptEditorBase.xml b/doc/classes/ScriptEditorBase.xml index 9968ae06c3..08baa705e8 100644 --- a/doc/classes/ScriptEditorBase.xml +++ b/doc/classes/ScriptEditorBase.xml @@ -1,64 +1,66 @@ <?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" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="highlighter" type="Object"> - </argument> + <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"> - </argument> + <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"> - </argument> + <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"> - </argument> + <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> - <argument index="1" name="line" type="int"> - </argument> + <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"> - </argument> + <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> |