Defines the responsibilities of handling external script editor integration into UnityEditor.
Installations | Provide the editor with a list of known and supported editors that this instance supports. |
Initialize | Callback to the IExternalCodeEditor when it has been chosen from the PreferenceWindow. |
OnGUI | Unity calls this methodf when it populates "Preferences/External Tools" in order to allow the code editor to generate necessary GUI. For example, when creating an an argument field for modifying the arguments sent to the code editor. |
OpenProject | The external code editor needs to handle the request to open a file. |
SyncAll | Unity calls this function during initialization in order to sync the Project. This is different from SyncIfNeeded in that it does not get a list of changes. |
SyncIfNeeded | When you change Assets in Unity, this method for the current chosen instance of IExternalCodeEditor parses the new and changed Assets. |
TryGetInstallationForPath | Unity stores the path of the chosen editor. An instance of IExternalCodeEditor can take responsibility for this path, by returning true when this method is being called. The out variable installation need to be constructed with the path and the name that should be shown in the "External Tools" code editor list. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.