summaryrefslogtreecommitdiff
path: root/doc/classes/EditorSyntaxHighlighter.xml
blob: 51f4474fe782d68a8fd42eb0b1586228edfb9029 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSyntaxHighlighter" inherits="SyntaxHighlighter" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base Syntax highlighter resource for the [ScriptEditor].
	</brief_description>
	<description>
		Base syntax highlighter resource all editor syntax highlighters extend from, it is used in the [ScriptEditor].
		Add a syntax highlighter to an individual script by calling [method ScriptEditorBase.add_syntax_highlighter]. To apply to all scripts on open, call [method ScriptEditor.register_syntax_highlighter]
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_get_name" qualifiers="virtual const">
			<return type="String" />
			<description>
				Virtual method which can be overridden to return the syntax highlighter name.
			</description>
		</method>
		<method name="_get_supported_languages" qualifiers="virtual const">
			<return type="PackedStringArray" />
			<description>
				Virtual method which can be overridden to return the supported language names.
			</description>
		</method>
	</methods>
</class>