Table of Contents

Class ScriptEditorBase

Namespace
Godot
Assembly
GodotSharpEditor.dll

Base editor for editing scripts in the ScriptEditor. This does not include documentation items.

public class ScriptEditorBase : VBoxContainer, IDisposable
Inheritance
ScriptEditorBase
Implements
Inherited Members

Methods

AddSyntaxHighlighter(EditorSyntaxHighlighter)

Adds a EditorSyntaxHighlighter to the open script.

public void AddSyntaxHighlighter(EditorSyntaxHighlighter highlighter)

Parameters

highlighter EditorSyntaxHighlighter

GetBaseEditor()

Returns the underlying Control used for editing scripts. For text scripts, this is a CodeEdit.

public Control GetBaseEditor()

Returns

Control

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

Events

EditedScriptChanged

Emitted after script validation.

public event Action EditedScriptChanged

Event Type

Action

GoToHelp

Emitted when the user requests a specific documentation page.

public event ScriptEditorBase.GoToHelpEventHandler GoToHelp

Event Type

ScriptEditorBase.GoToHelpEventHandler

GoToMethod

Emitted when the user requests to view a specific method of a script, similar to RequestOpenScriptAtLine.

public event ScriptEditorBase.GoToMethodEventHandler GoToMethod

Event Type

ScriptEditorBase.GoToMethodEventHandler

NameChanged

Emitted after script validation or when the edited resource has changed.

public event Action NameChanged

Event Type

Action

ReplaceInFilesRequested

Emitted when the user request to find and replace text in the file system.

public event ScriptEditorBase.ReplaceInFilesRequestedEventHandler ReplaceInFilesRequested

Event Type

ScriptEditorBase.ReplaceInFilesRequestedEventHandler

RequestHelp

Emitted when the user requests contextual help.

public event ScriptEditorBase.RequestHelpEventHandler RequestHelp

Event Type

ScriptEditorBase.RequestHelpEventHandler

RequestOpenScriptAtLine

Emitted when the user requests to view a specific line of a script, similar to GoToMethod.

public event ScriptEditorBase.RequestOpenScriptAtLineEventHandler RequestOpenScriptAtLine

Event Type

ScriptEditorBase.RequestOpenScriptAtLineEventHandler

RequestSaveHistory

Emitted when the user contextual goto and the item is in the same script.

public event Action RequestSaveHistory

Event Type

Action

SearchInFilesRequested

Emitted when the user request to search text in the file system.

public event ScriptEditorBase.SearchInFilesRequestedEventHandler SearchInFilesRequested

Event Type

ScriptEditorBase.SearchInFilesRequestedEventHandler
Edit this page