Class CodeEditingModule

Source code editing module.

Inheritance

System.Object

FlaxEditor.Modules.EditorModule

CodeEditingModule

Namespace: FlaxEditor.Modules.SourceCodeEditing

Assembly: FlaxEngine.CSharp.dll

Syntax

public sealed class CodeEditingModule : EditorModule

Fields

Actors

The actors collection.

Declaration

public readonly CachedTypesCollection Actors

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

All

The all types collection from all assemblies (excluding C# system libraries). Includes only primitive and basic types from std lib.

Declaration

public readonly CachedTypesCollection All

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

AllWithStd

The all types collection from all assemblies (including C# system libraries).

Declaration

public readonly CachedTypesCollection AllWithStd

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

AnimGraphNodes

The Animation Graph custom nodes collection.

Declaration

public readonly CachedCustomAnimGraphNodesCollection AnimGraphNodes

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedCustomAnimGraphNodesCollection

BehaviorTreeNodes

The Behavior Tree custom nodes collection.

Declaration

public readonly CachedTypesCollection BehaviorTreeNodes

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

Controls

The control types collection (for game UI).

Declaration

public readonly CachedTypesCollection Controls

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

Scripts

The scripts collection.

Declaration

public readonly CachedTypesCollection Scripts

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

VisualScriptPropertyTypes

The all valid types collection for the Visual Script property types (includes basic types like int/float, structures, object references).

Declaration

public readonly CachedTypesCollection VisualScriptPropertyTypes

Field Value

FlaxEditor.Modules.SourceCodeEditing.CachedTypesCollection

Properties

Editors

Gets the source code editors registered for usage in editor.

Declaration

public IReadOnlyList<ISourceCodeEditor> Editors { get; }

Property Value

System.Collections.Generic.IReadOnlyList<ISourceCodeEditor>

SelectedEditor

Gets or sets the selected editor.

Declaration

public ISourceCodeEditor SelectedEditor { get; set; }

Property Value

ISourceCodeEditor

Methods

AddEditor(ISourceCodeEditor)

Adds the editor to the collection.

Declaration

public void AddEditor(ISourceCodeEditor editor)

Parameters

ISourceCodeEditor editor The editor.

ClearTypes()

Clears all the cached types.

Declaration

public void ClearTypes()

OnEndInit()

Declaration

public override void OnEndInit()

Overrides

FlaxEditor.Modules.EditorModule.OnEndInit()

OnExit()

Declaration

public override void OnExit()

Overrides

FlaxEditor.Modules.EditorModule.OnExit()

OnInit()

Declaration

public override void OnInit()

Overrides

FlaxEditor.Modules.EditorModule.OnInit()

OnTypesChanged()

Calls the types change event to inform the Editor.

Declaration

public void OnTypesChanged()

OnUpdate()

Declaration

public override void OnUpdate()

Overrides

FlaxEditor.Modules.EditorModule.OnUpdate()

OpenFile(String, Int32)

Opens the file using the selected code editor.

Declaration

public void OpenFile(string path, int line = 0)

Parameters

System.String path The file path to open.

System.Int32 line The line number to navigate to. Use 0 to not use it.

OpenSolution()

Opens the solution file using the selected selected code editor.

Declaration

public void OpenSolution()

RemoveEditor(ISourceCodeEditor)

Removes the editor from the collection.

Declaration

public void RemoveEditor(ISourceCodeEditor editor)

Parameters

ISourceCodeEditor editor The editor.

Events

EditorAdded

Occurs when source code editor gets added.

Declaration

public event Action<ISourceCodeEditor> EditorAdded

Event Type

System.Action<ISourceCodeEditor>

EditorRemoved

Occurs when source code editor gets removed.

Declaration

public event Action<ISourceCodeEditor> EditorRemoved

Event Type

System.Action<ISourceCodeEditor>

SelectedEditorChanged

Occurs when selected source code editor gets changed.

Declaration

public event Action<ISourceCodeEditor> SelectedEditorChanged

Event Type

System.Action<ISourceCodeEditor>

TypesChanged

Occurs when types information gets modified (eg. after scripting reload or when script asset gets saved). Can be used to refresh any cached locally script types.

Declaration

public event Action TypesChanged

Event Type

System.Action

TypesCleared

Occurs when cached scripting types lists are cleared (eg. on global invalidation or scripting reload).

Declaration

public event Action TypesCleared

Event Type

System.Action

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.RawClone<T>(T)

See Also

FlaxEditor.Modules.EditorModule