Skip to main content

Editor Plugins

Editor plugins add features to the editor itself: asset types, document windows, panels, actions and property editors. They are loaded by the editor process only, never by the engine process or an exported game. Runtime code (components, systems) belongs in an engine plugin.

Editor plugins come from three places:

SourceWhere the binaries live
The engineThe engine's Binaries folder.
PackagesThe package's editor-<platform> component, installed for the computer the editor runs on. Editor plugins are not part of Android exports.
The projectThe project's Bin/<Platform>_x64_<Configuration> folder, next to the project's runtime plugin.

Project Editor Plugins​

A C++ project can have editor plugins of its own (the project template has none). They build into the project's Bin folder together with the runtime plugin, are committed with it, and are recorded in the plugin's code stamp. See Sharing C++ Projects.

The engine process can restart with new runtime code while the editor stays open, but the editor cannot unload its own plugins. When a project editor plugin changes, for example after a build or a teammate's sync, the editor asks:

The editor process must be restarted. Reason: 'The project's editor plugin changed.' Do you want to restart now?

Yes restarts the editor. No keeps working with the old plugin, and the status bar shows Restart the editor to apply changes. The same prompt appears with the reason The project's editor plugin was not loaded when the project opened. after you choose Load the code for a project whose code was not loaded. Headless runs never ask.

If the plugin bundle names an editor plugin that is not in the Bin folder, the C++ banner says so: the editor features it adds are missing until it is built there.

See Also​