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.

ScriptEditor

Eredita: PanelContainer < Container < Control < CanvasItem < Node < Object

Editor di script dell'editor Godot.

Descrizione

Editor di script dell'editor Godot.

Nota: Questa classe non dovrebbe essere istanziata direttamente. Invece, accedi al singleton usando EditorInterface.get_script_editor().

Metodi

void

clear_docs_from_script(script: Script)

Error

close_file(path: String)

PackedStringArray

get_breakpoints()

ScriptEditorBase

get_current_editor() const

Script

get_current_script()

Array[ScriptEditorBase]

get_open_script_editors() const

Array[Script]

get_open_scripts() const

PackedStringArray

get_unsaved_files() const

void

goto_help(topic: String)

void

goto_line(line_number: int)

void

open_script_create_dialog(base_name: String, base_path: String)

void

register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)

void

reload_open_files()

void

save_all_scripts()

void

unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)

void

update_docs_from_script(script: Script)


Segnali

editor_script_changed(script: Script) 🔗

Emesso quando l'utente ha modificato lo script attivo. L'argomento è uno Script appena attivato.


script_close(script: Script) 🔗

Emesso quando l'editor sta per chiudere lo script attivo. L'argomento è uno Script che sta per essere chiuso.


Descrizioni dei metodi

void clear_docs_from_script(script: Script) 🔗

Rimuove la documentazione per lo script specificato.

Nota: Questo dovrebbe essere chiamato ogni volta che lo script viene modificato per mantenere aggiornato lo stato della documentazione aperta.


Error close_file(path: String) 🔗

Chiude il file al percorso path, ignorando tutte le modifiche non salvate.

Restituisce @GlobalScope.OK in caso di successo oppure @GlobalScope.ERR_FILE_NOT_FOUND se il file non viene trovato.


PackedStringArray get_breakpoints() 🔗

Restituisce un array di punti d'interruzione.


ScriptEditorBase get_current_editor() const 🔗

Restituisce l'oggetto ScriptEditorBase che l'utente sta attualmente modificando.


Script get_current_script() 🔗

Restituisce uno Script che è attualmente attivo nell'editor.


Array[ScriptEditorBase] get_open_script_editors() const 🔗

Restituisce un array con tutti gli oggetti ScriptEditorBase che sono attualmente aperti nell'editor.


Array[Script] get_open_scripts() const 🔗

Restituisce un array con tutti gli oggetti Script che sono attualmente aperti nell'editor.


PackedStringArray get_unsaved_files() const 🔗

Returns an array of file paths of scripts with unsaved changes open in the editor.


void goto_help(topic: String) 🔗

Apre la guida per l'argomento specificato. Il topic è una stringa codificata che controlla quale classe, metodo, costante, segnale, annotazione, proprietà o elemento del tema deve essere focalizzato.

I formati topic supportati includono class_name:class, class_method:class:method, class_constant:class:constant, class_signal:class:signal, class_annotation:class:@annotation, class_property:class:property e class_theme_item:class:item, dove class è il nome di una classe, method è il nome di un metodo, constant è il nome di una costante, signal è il nome di un segnale, annotation è il nome di un'annotazione, property è il nome di una proprietà e item è un elemento del tema.

# Mostra la guida per la classe Node.
class_name:Node
# Mostra la guida per la funzione globale min.
# Gli oggetti globali sono accessibili nello spazio dei nomi `@GlobalScope`, mostrato qui.
class_method:@GlobalScope:min
# Mostra la guida per get_viewport nella classe Node.
class_method:Node:get_viewport
# Mostra la guida per la costante di input MOUSE_BUTTON_MIDDLE.
class_constant:Input:MOUSE_BUTTON_MIDDLE
# Mostra la guida per il segnale BaseButton premuto.
class_signal:BaseButton:pressed
# Mostra la guida per la proprietà CanvasItem visible.
class_property:CanvasItem:visible
# Mostra la guida per l'annotazione GDScript export.
# Le annotazioni devono essere precedute dal simbolo `@` nel descrittore, come mostrato qui.
class_annotation:@GDScript:@export
# Mostra la guida per l'elemento del tema GraphNode con il nome panel_selected.
class_theme_item:GraphNode:panel_selected

void goto_line(line_number: int) 🔗

Va alla riga specificata nello script attuale.


void open_script_create_dialog(base_name: String, base_path: String) 🔗

Apre la finestra di dialogo di creazione dello script. Lo script estenderà base_name. L'estensione del file può essere omessa dal percorso base_path. Sarà aggiunta in base al linguaggio di scripting selezionato.


void register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) 🔗

Registra l'EditorSyntaxHighlighter nell'editor, l'EditorSyntaxHighlighter sarà disponibile su tutti gli script aperti.

Nota: Non si applica agli script che sono già aperti.


void reload_open_files() 🔗

Reloads all currently opened files. This should be used when opened files are changed outside of the script editor. The user may be prompted to resolve file conflicts, see EditorSettings.text_editor/behavior/files/auto_reload_scripts_on_external_change.


void save_all_scripts() 🔗

Saves all open scripts.


void unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) 🔗

Annulla la registrazione del EditorSyntaxHighlighter dall'editor.

Nota: EditorSyntaxHighlighter sarà comunque applicato agli script che sono già aperti.


void update_docs_from_script(script: Script) 🔗

Aggiorna la documentazione per lo script specificato.

Nota: Questo dovrebbe essere chiamato ogni volta che lo script viene modificato per mantenere aggiornato lo stato della documentazione aperta.