ScriptEditorBase — C# API

class ScriptEditorBaseReckfellSharpEditorInherits VBoxContainer

Base editor for editing scripts in the ScriptEditor.

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

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Methods2

AddSyntaxHighlightervoid

C#
public void AddSyntaxHighlighter(EditorSyntaxHighlighter highlighter);

Adds an EditorSyntaxHighlighter to the open script.

Parameters
Name	Type	Default
`highlighter`	`EditorSyntaxHighlighter`	—

GetBaseEditorControl

# GetBaseEditor

C#
public Control GetBaseEditor();

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

Returns Control

Signals and events10

EditedScriptChangedEvent · Deprecated

# EditedScriptChanged

public event Action EditedScriptChanged;

Emitted after script validation.

GoToHelpEvent · Deprecated

# GoToHelp

public event ScriptEditorBase.GoToHelpEventHandler GoToHelp;

Emitted when the user requests a specific documentation page.

Handler parameters
Name	Type	Default
`what`	`string`	—

GoToMethodEvent · Deprecated

# GoToMethod

public event ScriptEditorBase.GoToMethodEventHandler GoToMethod;

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

Handler parameters
Name	Type	Default
`script`	`ReckfellObject`	—
`method`	`string`	—

NameChangedEvent · Deprecated

# NameChanged

public event Action NameChanged;

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

ReplaceInFilesRequestedEvent · Deprecated

# ReplaceInFilesRequested

public event ScriptEditorBase.ReplaceInFilesRequestedEventHandler ReplaceInFilesRequested;

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

Handler parameters
Name	Type	Default
`text`	`string`	—

RequestHelpEvent · Deprecated

# RequestHelp

public event ScriptEditorBase.RequestHelpEventHandler RequestHelp;

Emitted when the user requests contextual help.

Handler parameters
Name	Type	Default
`topic`	`string`	—

RequestOpenScriptAtLineEvent · Deprecated

# RequestOpenScriptAtLine

public event ScriptEditorBase.RequestOpenScriptAtLineEventHandler RequestOpenScriptAtLine;

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

Handler parameters
Name	Type	Default
`script`	`ReckfellObject`	—
`line`	`long`	—

RequestSaveHistoryEvent · Deprecated

# RequestSaveHistory

public event Action RequestSaveHistory;

Emitted when the editor requests to save a new history navigation point.

RequestSavePreviousStateEvent · Deprecated

# RequestSavePreviousState

public event ScriptEditorBase.RequestSavePreviousStateEventHandler RequestSavePreviousState;

Emitted when the editor requests an update to its navigation point.

Handler parameters
Name	Type	Default
`state`	`Reckfell.Collections.Dictionary`	—

SearchInFilesRequestedEvent · Deprecated

# SearchInFilesRequested

public event ScriptEditorBase.SearchInFilesRequestedEventHandler SearchInFilesRequested;

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

Handler parameters
Name	Type	Default
`text`	`string`	—