summaryrefslogtreecommitdiff
path: root/doc/classes/ScriptEditor.xml
blob: 28620bd29bc69ef8919739d6528e5786287a8daf (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptEditor" inherits="PanelContainer" version="4.0">
	<brief_description>
		Godot editor's script editor.
	</brief_description>
	<description>
		[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_script_editor].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="can_drop_data_fw" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="point" type="Vector2">
			</argument>
			<argument index="1" name="data" type="Variant">
			</argument>
			<argument index="2" name="from" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="drop_data_fw">
			<return type="void">
			</return>
			<argument index="0" name="point" type="Vector2">
			</argument>
			<argument index="1" name="data" type="Variant">
			</argument>
			<argument index="2" name="from" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_current_editor" qualifiers="const">
			<return type="ScriptEditorBase">
			</return>
			<description>
				Returns the [ScriptEditorBase] object that the user is currently editing.
			</description>
		</method>
		<method name="get_current_script">
			<return type="Script">
			</return>
			<description>
				Returns a [Script] that is currently active in editor.
			</description>
		</method>
		<method name="get_drag_data_fw">
			<return type="Variant">
			</return>
			<argument index="0" name="point" type="Vector2">
			</argument>
			<argument index="1" name="from" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_open_script_editors" qualifiers="const">
			<return type="Array">
			</return>
			<description>
				Returns an array with all [ScriptEditorBase] objects which are currently open in editor.
			</description>
		</method>
		<method name="get_open_scripts" qualifiers="const">
			<return type="Array">
			</return>
			<description>
				Returns an array with all [Script] objects which are currently open in editor.
			</description>
		</method>
		<method name="goto_line">
			<return type="void">
			</return>
			<argument index="0" name="line_number" type="int">
			</argument>
			<description>
				Goes to the specified line in the current script.
			</description>
		</method>
		<method name="open_script_create_dialog">
			<return type="void">
			</return>
			<argument index="0" name="base_name" type="String">
			</argument>
			<argument index="1" name="base_path" type="String">
			</argument>
			<description>
				Opens the script create dialog. The script will extend [code]base_name[/code]. The file extension can be omitted from [code]base_path[/code]. It will be added based on the selected scripting language.
			</description>
		</method>
		<method name="register_syntax_highlighter">
			<return type="void">
			</return>
			<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
			</argument>
			<description>
				Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts.
				[b]Note:[/b] Does not apply to scripts that are already opened.
			</description>
		</method>
		<method name="unregister_syntax_highlighter">
			<return type="void">
			</return>
			<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
			</argument>
			<description>
				Unregisters the [EditorSyntaxHighlighter] from the editor.
				[b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="editor_script_changed">
			<argument index="0" name="script" type="Script">
			</argument>
			<description>
				Emitted when user changed active script. Argument is a freshly activated [Script].
			</description>
		</signal>
		<signal name="script_close">
			<argument index="0" name="script" type="Script">
			</argument>
			<description>
				Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>