2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-03-01 00:44:37 +00:00
<class name= "EditorScript" inherits= "RefCounted" version= "4.1" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-10-17 23:28:05 +00:00
Base script that can be used to add extension functions to the editor.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2020-03-10 10:41:36 +00:00
Scripts extending this class and implementing its [method _run] method can be executed from the Script Editor's [b]File > Run[/b] menu option (or by pressing [kbd]Ctrl + Shift + X[/kbd]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]s instead.
2019-11-08 22:31:29 +00:00
[b]Note:[/b] Extending scripts need to have [code]tool[/code] mode enabled.
2019-06-21 23:04:47 +00:00
[b]Example script:[/b]
2020-09-13 12:45:36 +00:00
[codeblocks]
[gdscript]
2022-09-21 20:49:03 +00:00
@tool
2017-10-17 23:28:05 +00:00
extends EditorScript
2017-12-06 23:28:40 +00:00
2017-10-17 23:28:05 +00:00
func _run():
2017-10-22 22:35:10 +00:00
print("Hello from the Godot Editor!")
2020-09-13 12:45:36 +00:00
[/gdscript]
[csharp]
using Godot;
[Tool]
2023-01-31 17:21:09 +00:00
public partial class HelloEditor : EditorScript
2020-09-13 12:45:36 +00:00
{
public override void _Run()
{
GD.Print("Hello from the Godot Editor!");
}
}
[/csharp]
[/codeblocks]
2019-06-21 23:04:47 +00:00
[b]Note:[/b] The script is run in the Editor context, which means the output is visible in the console window started with the Editor (stdout) instead of the usual Godot [b]Output[/b] dock.
2022-09-23 21:55:19 +00:00
[b]Note:[/b] EditorScript is [RefCounted], meaning it is destroyed when nothing references it. This can cause errors during asynchronous operations if there are no references to the script.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "_run" qualifiers= "virtual" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-21 23:04:47 +00:00
This method is executed by the Editor when [b]File > Run[/b] is used.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_root_node" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "node" type= "Node" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-12 16:07:53 +00:00
Adds [param node] as a child of the root node in the editor context.
2019-06-21 23:04:47 +00:00
[b]Warning:[/b] The implementation of this method is currently disabled.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_editor_interface" >
2021-07-30 13:28:05 +00:00
<return type= "EditorInterface" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-17 23:28:05 +00:00
Returns the [EditorInterface] singleton instance.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_scene" >
2021-07-30 13:28:05 +00:00
<return type= "Node" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-17 23:28:05 +00:00
Returns the Editor's currently active scene.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
</class>