EditorScript

Наследует: RefCounted < Object

Базовый скрипт, который можно использовать для добавления функций расширения в редактор.

Описание

Скрипты, расширяющие этот класс и реализующие его метод _run(), можно запустить из меню Файл > Выполнить редактора скриптов (или нажатием Ctrl + Shift + X) во время работы редактора. Это полезно для добавления собственных функций редактора в Godot. Для более сложных дополнений рассмотрите возможность использования EditorPlugin.

Если скрипт, расширяющий этот класс, также имеет глобальное имя класса, он будет включён в палитру команд редактора.

Примечание: Для расширения скриптов необходимо включить режим tool.

Пример: При запуске следующего скрипта будет выведено сообщение «Привет из редактора Godot!»:

@tool
extends EditorScript

func _run():
    print("Привет из редактора Godot!")

using Godot;

[Tool]
public partial class HelloEditor : EditorScript
{
    public override void _Run()
    {
        GD.Print("Привет из редактора Godot!");
    }
}

Примечание: EditorScript это RefCounted, то есть он уничтожается, если на него нет ссылок. Это может привести к ошибкам во время асинхронных операций, если на скрипт нет ссылок.

Методы

void	_run() virtual required
void	add_root_node(node: Node)
EditorInterface	get_editor_interface() const
Node	get_scene() const

Описания метода

void _run() virtual required 🔗

Этот метод выполняется редактором при использовании Файл > Выполнить.

void add_root_node(node: Node) 🔗

Устарело: Use EditorInterface.add_root_node() instead.

Делает node корнем текущей открытой сцены. Работает только если сцена пуста. Если node является экземпляром сцены, будет создана наследующая сцена.

EditorInterface get_editor_interface() const 🔗

Устарело: EditorInterface is a global singleton and can be accessed directly by its name.

Возвращает экземпляр синглтона EditorInterface.

Node get_scene() const 🔗

Устарело: Use EditorInterface.get_edited_scene_root() instead.

Возвращает корень Node редактируемой (текущей) сцены. Эквивалент EditorInterface.get_edited_scene_root().