summaryrefslogtreecommitdiffstats
path: root/doc/classes/ScriptEditor.xml
diff options
context:
space:
mode:
authorPaulb23 <p_batty@hotmail.co.uk>2020-10-11 17:07:33 +0100
committerPaulb23 <p_batty@hotmail.co.uk>2020-10-11 17:14:37 +0100
commitb7079203553d802db906bf6241cf9223b882955c (patch)
tree789414cf687dbb9e586fb51f8191767e940f0b6f /doc/classes/ScriptEditor.xml
parentbf37ab52b3ee4b14f235cfa1ea9e48c24c616bb3 (diff)
downloadredot-engine-b7079203553d802db906bf6241cf9223b882955c.tar.gz
Update SyntaxHighlighter documentation
Diffstat (limited to 'doc/classes/ScriptEditor.xml')
-rw-r--r--doc/classes/ScriptEditor.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml
index d5a32dd20c..28620bd29b 100644
--- a/doc/classes/ScriptEditor.xml
+++ b/doc/classes/ScriptEditor.xml
@@ -37,6 +37,7 @@
<return type="ScriptEditorBase">
</return>
<description>
+ Returns the [ScriptEditorBase] object that the user is currently editing.
</description>
</method>
<method name="get_current_script">
@@ -60,6 +61,7 @@
<return type="Array">
</return>
<description>
+ Returns an array with all [ScriptEditorBase] objects which are currently open in editor.
</description>
</method>
<method name="get_open_scripts" qualifiers="const">
@@ -95,6 +97,8 @@
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<description>
+ Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts.
+ [b]Note:[/b] Does not apply to scripts that are already opened.
</description>
</method>
<method name="unregister_syntax_highlighter">
@@ -103,6 +107,8 @@
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<description>
+ Unregisters the [EditorSyntaxHighlighter] from the editor.
+ [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
</description>
</method>
</methods>