:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/modules/gdscript/doc_classes/GDScriptTextDocument.xml. .. _class_GDScriptTextDocument: GDScriptTextDocument ==================== **Deprecated:** This class may be changed or removed in future versions. **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Document related language server functionality. .. rst-class:: classref-introduction-group Description ----------- Provides language server functionality related to documents. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`codeLens`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`colorPresentation`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`completion`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`declaration`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`definition`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`didChange`\ (\ params\: :ref:`Variant`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`didClose`\ (\ params\: :ref:`Variant`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`didOpen`\ (\ params\: :ref:`Variant`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`didSave`\ (\ params\: :ref:`Variant`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`documentLink`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`documentSymbol`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`foldingRange`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`hover`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`nativeSymbol`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`prepareRename`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`references`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`rename`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`resolve`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`show_native_symbol_in_editor`\ (\ symbol_id\: :ref:`String`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`signatureHelp`\ (\ params\: :ref:`Dictionary`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`willSaveWaitUntil`\ (\ params\: :ref:`Variant`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GDScriptTextDocument_method_codeLens: .. rst-class:: classref-method :ref:`Array` **codeLens**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_colorPresentation: .. rst-class:: classref-method :ref:`Array` **colorPresentation**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_completion: .. rst-class:: classref-method :ref:`Array` **completion**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_declaration: .. rst-class:: classref-method :ref:`Variant` **declaration**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_definition: .. rst-class:: classref-method :ref:`Array` **definition**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_didChange: .. rst-class:: classref-method |void| **didChange**\ (\ params\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_didClose: .. rst-class:: classref-method |void| **didClose**\ (\ params\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_didOpen: .. rst-class:: classref-method |void| **didOpen**\ (\ params\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_didSave: .. rst-class:: classref-method |void| **didSave**\ (\ params\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_documentLink: .. rst-class:: classref-method :ref:`Array` **documentLink**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_documentSymbol: .. rst-class:: classref-method :ref:`Array` **documentSymbol**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_foldingRange: .. rst-class:: classref-method :ref:`Array` **foldingRange**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_hover: .. rst-class:: classref-method :ref:`Variant` **hover**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_nativeSymbol: .. rst-class:: classref-method :ref:`Variant` **nativeSymbol**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_prepareRename: .. rst-class:: classref-method :ref:`Variant` **prepareRename**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_references: .. rst-class:: classref-method :ref:`Array` **references**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_rename: .. rst-class:: classref-method :ref:`Dictionary` **rename**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_resolve: .. rst-class:: classref-method :ref:`Dictionary` **resolve**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_show_native_symbol_in_editor: .. rst-class:: classref-method |void| **show_native_symbol_in_editor**\ (\ symbol_id\: :ref:`String`\ ) :ref:`🔗` **Deprecated:** Use :ref:`ScriptEditor.goto_help()` instead. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_signatureHelp: .. rst-class:: classref-method :ref:`Variant` **signatureHelp**\ (\ params\: :ref:`Dictionary`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. rst-class:: classref-item-separator ---- .. _class_GDScriptTextDocument_method_willSaveWaitUntil: .. rst-class:: classref-method |void| **willSaveWaitUntil**\ (\ params\: :ref:`Variant`\ ) :ref:`🔗` **Deprecated:** Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`