Version: 2021.1
LanguageEnglish
  • C#

CodeEditor

class in Unity.CodeEditor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Handles interaction with the code editor.

Static Properties

CurrentEditorPathThe path to the external code editor that Unity uses used to open script assets.
EditorA singleton instance of CodeEditor. The Unity Editor references this instance to handle code editor callbacks.

Properties

CurrentCodeEditorReturns the current IExternalCodeEditor instance for the code editor.
CurrentInstallationReturns the current CodeEditor.Installation instance for the code editor.

Public Methods

GetCodeEditorForPathEach registered code editor package has an instance of IExternalCodeEditor. This method invokes IExternalCodeEditor.TryGetInstallationForPath on that instance. It returns the first instance that returns a valid installation.
GetFoundScriptEditorPathsCollects all installations from registered instances of IExternalCodeEditor. This is done using IExternalCodeEditor.Installations.
GetInstallationForPathEach registered code editor package has an instance of IExternalCodeEditor. This method invokes IExternalCodeEditor.TryGetInstallationForPath on that instance. It finds the first instance that returns a valid installation, and returns the installation.
SetCodeEditorSets the path to the code editor that Unity uses to open script assets.

Static Methods

OSOpenFileOpen an application with a quoted string of arguments.
ParseArgumentParse a string using the rules defined under External Tools.
QuoteForProcessStartQuotes a string to pass to Process.Start as a single argument, and appends it to this string builder.
RegisterRegister an instance of IExternalCodeEditor to use when populating Preferences/External Tools menu. Calls ref::Initialize if you select the instance.
UnregisterRemove an instance of IExternalCodeEditor from the list of registered code editors. Calls ref::Initialize if you select the instance.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961