Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
 Path: blob/master/modules/gdscript/doc_classes/GDScriptLanguageProtocol.xml
46004 views
1
<?xml version="1.0" encoding="UTF-8" ?>

2
<class name="GDScriptLanguageProtocol" inherits="JSONRPC" api_type="editor" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">

3
	<brief_description>

4
		GDScript language server.

5
	</brief_description>

6
	<description>

7
		Provides access to certain features that are implemented in the language server.

8
		[b]Note:[/b] 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.

9
	</description>

10
	<tutorials>

11
	</tutorials>

12
	<methods>

13
		<method name="get_text_document" deprecated="[GDScriptTextDocument] is deprecated.">

14
			<return type="GDScriptTextDocument" />

15
			<description>

16
				Returns the language server's [GDScriptTextDocument] instance.

17
			</description>

18
		</method>

19
		<method name="get_workspace">

20
			<return type="GDScriptWorkspace" />

21
			<description>

22
				Returns the language server's [GDScriptWorkspace] instance.

23
			</description>

24
		</method>

25
		<method name="initialize" deprecated="Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client.">

26
			<return type="Dictionary" />

27
			<param index="0" name="params" type="Dictionary" />

28
			<description>

29
			</description>

30
		</method>

31
		<method name="initialized" deprecated="Accessing LSP endpoints directly might lead to unwanted side effects. Connect to the server via TCP, like a regular language server client.">

32
			<return type="void" />

33
			<param index="0" name="params" type="Variant" />

34
			<description>

35
			</description>

36
		</method>

37
		<method name="is_initialized" qualifiers="const">

38
			<return type="bool" />

39
			<description>

40
				Returns [code]true[/code] if the language server was initialized by a language server client, [code]false[/code] otherwise.

41
			</description>

42
		</method>

43
		<method name="is_smart_resolve_enabled" qualifiers="const">

44
			<return type="bool" />

45
			<description>

46
				Returns [code]true[/code] if the language server is providing the smart resolve feature, [code]false[/code] otherwise. The feature can be configured through the editor settings.

47
			</description>

48
		</method>

49
		<method name="notify_client" deprecated="Might result in unwanted side effects for connected clients.">

50
			<return type="void" />

51
			<param index="0" name="method" type="String" />

52
			<param index="1" name="params" type="Variant" default="null" />

53
			<param index="2" name="client_id" type="int" default="-1" />

54
			<description>

55
			</description>

56
		</method>

57
		<method name="on_client_connected" deprecated="Might result in unwanted side effects for connected clients.">

58
			<return type="int" enum="Error" />

59
			<description>

60
			</description>

61
		</method>

62
		<method name="on_client_disconnected" deprecated="Might result in unwanted side effects for connected clients.">

63
			<return type="void" />

64
			<param index="0" name="client_id" type="int" />

65
			<description>

66
			</description>

67
		</method>

68
	</methods>

69
</class>

70


71