| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the EditorSyntaxHighlighter.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_EditorSyntaxHighlighter:
- EditorSyntaxHighlighter
- =======================
- **Inherits:** :ref:`SyntaxHighlighter<class_SyntaxHighlighter>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Base Syntax highlighter resource for the :ref:`ScriptEditor<class_ScriptEditor>`.
- Description
- -----------
- Base syntax highlighter resource all editor syntax highlighters extend from, it is used in the :ref:`ScriptEditor<class_ScriptEditor>`.
- Add a syntax highlighter to an individual script by calling :ref:`ScriptEditorBase.add_syntax_highlighter<class_ScriptEditorBase_method_add_syntax_highlighter>`. To apply to all scripts on open, call :ref:`ScriptEditor.register_syntax_highlighter<class_ScriptEditor_method_register_syntax_highlighter>`
- Methods
- -------
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`_get_name<class_EditorSyntaxHighlighter_method__get_name>` **(** **)** |virtual| |const| |
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`_get_supported_languages<class_EditorSyntaxHighlighter_method__get_supported_languages>` **(** **)** |virtual| |const| |
- +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_EditorSyntaxHighlighter_method__get_name:
- - :ref:`String<class_String>` **_get_name** **(** **)** |virtual| |const|
- Virtual method which can be overridden to return the syntax highlighter name.
- ----
- .. _class_EditorSyntaxHighlighter_method__get_supported_languages:
- - :ref:`Array<class_Array>` **_get_supported_languages** **(** **)** |virtual| |const|
- Virtual method which can be overridden to return the supported language names.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
