Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

EditorScript

Hérite de : RefCounted < Object

Script de base qui permet d'étendre les fonctionnalités de l'éditeur.

Description

Les scripts héritant de cette classe et implémentant la méthode _run() peuvent être exécutés depuis l'éditeur de script avec l'option de menu Fichier > Lancer (ou avec Ctrl + Shift + X) quand l'éditeur est lancé. C'est utilise pour ajouter des fonctionnalités personnalisées dans l'éditeur de Godot. Pour des additions plus complexes, préférez plutôt utiliser EditorPlugin.

Si un script élargissant cette classe a également un nom de classe mondial, il sera inclus dans la palette de commandes de l'éditeur.

Note : Les scripts doivent activer le mode tool pour cela.

Exemple :Lancer le script suivant affiche"Bonjour de l'Éditeur Godot!":

@tool
extends EditorScript

func _run():
    print("Hello from the Godot Editor!")

using Godot;

[Tool]
public partial class HelloEditor : EditorScript
{
    public override void _Run()
    {
        GD.Print("Hello from the Godot Editor!");
    }
}

Note : EditorScript est RefCounted, ce qui signifie qu'il est détruit quand rien ne le mentionne. Cela peut causer des erreurs lors d'opérations asynchrones s'il n'y a aucune référence au script.

Méthodes

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

Descriptions des méthodes

void _run() virtual required 🔗

Cette méthode est exécutée par l'éditeur quand Ficher > Exécuter est utilisé.

void add_root_node(node: Node) 🔗

Obsolète : Use EditorInterface.add_root_node() instead.

Makes node root of the currently opened scene. Only works if the scene is empty. If the node is a scene instance, an inheriting scene will be created.

EditorInterface get_editor_interface() const 🔗

Obsolète : EditorInterface is a global singleton and can be accessed directly by its name.

Returns the EditorInterface singleton instance.

Node get_scene() const 🔗

Obsolète : Use EditorInterface.get_edited_scene_root() instead.

Returns the edited (current) scene's root Node. Equivalent of EditorInterface.get_edited_scene_root().