: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/GDScriptLanguageProtocol.xml. .. _class_GDScriptLanguageProtocol: GDScriptLanguageProtocol ======================== **Experimental:** This class may be changed or removed in future versions. **Inherits:** :ref:`JSONRPC` **<** :ref:`Object` GDScript language server. .. rst-class:: classref-introduction-group Description ----------- Provides access to certain features that are implemented in the language server. \ **Note:** This class is not a language server client that can be used to access LSP functionality. It only provides access to a limited set of features that is implemented using the same technical foundation as the language server. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GDScriptTextDocument` | :ref:`get_text_document`\ (\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GDScriptWorkspace` | :ref:`get_workspace`\ (\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`initialize`\ (\ params\: :ref:`Dictionary`\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`initialized`\ (\ params\: :ref:`Variant`\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_initialized`\ (\ ) |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_smart_resolve_enabled`\ (\ ) |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`notify_client`\ (\ method\: :ref:`String`, params\: :ref:`Variant` = null, client_id\: :ref:`int` = -1\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`on_client_connected`\ (\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`on_client_disconnected`\ (\ client_id\: :ref:`int`\ ) | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GDScriptLanguageProtocol_method_get_text_document: .. rst-class:: classref-method :ref:`GDScriptTextDocument` **get_text_document**\ (\ ) :ref:`🔗` **Deprecated:** :ref:`GDScriptTextDocument` is deprecated. Returns the language server's :ref:`GDScriptTextDocument` instance. .. rst-class:: classref-item-separator ---- .. _class_GDScriptLanguageProtocol_method_get_workspace: .. rst-class:: classref-method :ref:`GDScriptWorkspace` **get_workspace**\ (\ ) :ref:`🔗` Returns the language server's :ref:`GDScriptWorkspace` instance. .. rst-class:: classref-item-separator ---- .. _class_GDScriptLanguageProtocol_method_initialize: .. rst-class:: classref-method :ref:`Variant` **initialize**\ (\ 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_GDScriptLanguageProtocol_method_initialized: .. rst-class:: classref-method |void| **initialized**\ (\ 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_GDScriptLanguageProtocol_method_is_initialized: .. rst-class:: classref-method :ref:`bool` **is_initialized**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the language server was initialized by a language server client, ``false`` otherwise. .. rst-class:: classref-item-separator ---- .. _class_GDScriptLanguageProtocol_method_is_smart_resolve_enabled: .. rst-class:: classref-method :ref:`bool` **is_smart_resolve_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the language server is providing the smart resolve feature, ``false`` otherwise. The feature can be configured through the editor settings. .. rst-class:: classref-item-separator ---- .. _class_GDScriptLanguageProtocol_method_notify_client: .. rst-class:: classref-method |void| **notify_client**\ (\ method\: :ref:`String`, params\: :ref:`Variant` = null, client_id\: :ref:`int` = -1\ ) :ref:`🔗` **Deprecated:** Might result in unwanted side effects for connected clients. .. rst-class:: classref-item-separator ---- .. _class_GDScriptLanguageProtocol_method_on_client_connected: .. rst-class:: classref-method :ref:`Error` **on_client_connected**\ (\ ) :ref:`🔗` **Deprecated:** Might result in unwanted side effects for connected clients. .. rst-class:: classref-item-separator ---- .. _class_GDScriptLanguageProtocol_method_on_client_disconnected: .. rst-class:: classref-method |void| **on_client_disconnected**\ (\ client_id\: :ref:`int`\ ) :ref:`🔗` **Deprecated:** Might result in unwanted side effects for connected clients. .. |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.)`