Search Results for

    Show / Hide Table of Contents

    Class RiderCodeEditor

    Implementation of code editor utility that is using Rider from JetBrains.

    Inheritance
    CodeEditor
    RiderCodeEditor
    Inherited Members
    CodeEditor::UseAsyncForOpen()
    CodeEditor::~CodeEditor()
    Assembly: FlaxEngine.dll
    File: Editor/Scripting/CodeEditors/RiderCodeEditor.h
    Syntax
    public class RiderCodeEditor : public CodeEditor

    Constructors

    RiderCodeEditor(const String& execPath)

    Initializes a new instance of the VisualStudioEditor class.

    Declaration
    public RiderCodeEditor(const String& execPath)
    Parameters
    String execPath

    Executable file path

    Methods

    FindEditors(Array<CodeEditor* >* output)

    Tries to find installed Visual Studio Code instance. Adds them to the result list.

    Declaration
    public static void FindEditors(Array<CodeEditor* >* output)
    Parameters
    Array<CodeEditor > output

    The output editors.

    GetGenerateProjectCustomArgs()

    Gets the custom arguments for the Flax.Build tool to add when generating project files for this code editor.

    Declaration
    public virtual String GetGenerateProjectCustomArgs() const override
    Returns
    String

    The custom arguments to generate project files.

    Overrides
    CodeEditor::GetGenerateProjectCustomArgs()

    GetName()

    Gets the name of the editor.

    Declaration
    public virtual String GetName() const override
    Returns
    String

    The name.

    Overrides
    CodeEditor::GetName()

    GetType()

    Gets the type of the editor (used by the in-build editors).

    Declaration
    public virtual CodeEditorTypes GetType() const override
    Returns
    CodeEditorTypes

    The name

    Overrides
    CodeEditor::GetType()

    OnFileAdded(const String& path)

    Called when source file gets added to the workspace. Can be used to automatically include new files into the project files.

    Declaration
    public virtual void OnFileAdded(const String& path) override
    Parameters
    String path

    The path.

    Overrides
    CodeEditor::OnFileAdded(const String& path)

    OpenFile(const String& path, int32 line)

    Opens the file.

    Declaration
    public virtual void OpenFile(const String& path, int32 line) override
    Parameters
    String path

    The file path.

    int32 line

    The target line (use 0 to not use it).

    Overrides
    CodeEditor::OpenFile(const String& path, int32 line)

    OpenSolution()

    Opens the solution project.

    Declaration
    public virtual void OpenSolution() override
    Overrides
    CodeEditor::OpenSolution()
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat