ScriptEditor

public void ClearDocsFromScript(Script script);

Removes the documentation for the given script. Note: This should be called whenever the script is changed to keep the open documentation state up to date.

public Error CloseFile(string path);

Closes the file at the given path, discarding any unsaved changes. Returns OK on success or ERR_FILE_NOT_FOUND if the file is not found.

public string[] GetBreakpoints();

Returns array of breakpoints.

public ScriptEditorBase GetCurrentEditor();

Return the current ScriptEditorBase when the active document has that type. A help tab does not, so null is valid. This does not retrieve an external editor process.

public Script GetCurrentScript();

Return the active internal editor Script. Help tabs or the absence of a suitable document return null. This does not determine the active file in an external C# IDE.

public Reckfell.Collections.Array<ScriptEditorBase> GetOpenScriptEditors();

Returns an array with all ScriptEditorBase objects which are currently open in editor.

public Reckfell.Collections.Array<Script> GetOpenScripts();

List Script resources open in internal documents. Help and arbitrary text files do not become scripts; this is not an index of all project files or external IDE documents.

public string[] GetUnsavedFiles();

List internal document paths with unsaved buffers. This excludes unsaved external IDE text and does not establish that an entire scene or project is saved.

public void GotoHelp(string topic);

Open built-in help using a descriptor such as class_name:Entity. This neither opens a Script nor chooses an external C# IDE; GetCurrentScript() can return null afterward.

public void GotoLine(int lineNumber);

Goes to the specified line in the current script.

public void OpenScriptCreateDialog(string baseName, string basePath);

Opens the script create dialog. The script will extend base_name. The file extension can be omitted from base_path. It will be added based on the selected scripting language.

public void RegisterSyntaxHighlighter(EditorSyntaxHighlighter syntaxHighlighter);

Registers the EditorSyntaxHighlighter to the editor, the EditorSyntaxHighlighter will be available on all open scripts. Note: Does not apply to scripts that are already opened.

public void ReloadOpenFiles();

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.

public void SaveAllScripts();

Saves all open scripts.

public void UnregisterSyntaxHighlighter(EditorSyntaxHighlighter syntaxHighlighter);

Unregisters the EditorSyntaxHighlighter from the editor. Note: The EditorSyntaxHighlighter will still be applied to scripts that are already opened.

public void UpdateDocsFromScript(Script script);

Updates the documentation for the given script. Note: This should be called whenever the script is changed to keep the open documentation state up to date.

public event ScriptEditor.EditorScriptChangedEventHandler EditorScriptChanged;

Emitted when user changed active script. Argument is a freshly activated Script.

public event ScriptEditor.ScriptCloseEventHandler ScriptClose;

Emitted when editor is about to close the active script. Argument is a Script that is going to be closed.