class
EditorApplication
Primary editor class containing the editor entry point.
Public
Constructors
EditorApplication
Methods
~EditorApplication
staticStartUp
Starts the editor with the specified render and audio systems.
staticInstance
Returns a reference to the module instance.
Module has to have been started up first otherwise an exception will be thrown.
IsProjectLoaded
Checks whether the editor currently has a project loaded.
GetProjectName
Returns the name of the currently loaded project.
GetEditorSettings
Returns a set of serializable editor settings that contain every globally customizable editor property.
GetProjectSettings
Returns a set of serializable project settings that contain every customizable property specific to a project.
GetUndoRedo
Returns the global undo-redo manager.
Use this to register undoable operations that are not tied to a particular window, but rather to editor as a whole.
SaveEditorSettings
Saves the current editor settings at the default location.
SaveProjectSettings
Saves the current project settings at the default location.
Does nothing if no project is loaded.
SaveProject
Saves any project specific data, if a project is currently loaded.
UnloadProject
Unloads the currently loaded project, if any.
LoadProject
Loads a new project, unloading the current one.
- path
- Absolute path to the root project folder. Must be pointing to a valid project.
CreateProject
Creates a new project at the specified path.
- path
- Path to the folder where to create the project in. Name of this folder will be the name of the project.
IsValidProjectPath
Checks is the provided folder a valid project.
- path
- Absolute path to the root project folder.
SetMainScene
Provides access to what is considered the main scene in the editor.
Main scene is the primary scene shown in the scene, game and hierarchy windows. Guaranteed not to be null except during startup and shutdown.
GetMainScene
IsEditor
Returns true if the application is running in an editor, false if standalone.
Fields
OnQuitRequested
Callback when the user requests application exit.
The receiver is expected to handle shutdown if required.
Private
Methods
OnStartUp
Override if you want your module to be notified once it has been constructed and started.
OnShutDown
Override if you want your module to be notified just before it is deleted.
PreUpdate
Called for each iteration of the main loop.
Called before any game objects or plugins are updated.
PostUpdate
Called for each iteration of the main loop.
Called after all game objects and plugins are updated.
NotifyQuitRequested
Issues a request for the application to close.
Application may choose to ignore the request depending on the circumstances and the implementation.
StartUpRenderer
Initializes the renderer specified during construction.
Called during initialization.
StartUpScriptManager
Initializes the script manager.
UpdateScriptManager
Calls per-frame update on the script manager.
GetShaderIncludeHandler
Returns a handler that is used for resolving shader include file paths.
LoadWidgetLayout
Loads the previously saved editor widget layout from the default location.
Can return null if no layout was previously saved.
SaveWidgetLayout
Saves the provided widget layout at the default layout location.
SaveDefaultWidgetLayout
Saves the default widget layout in the provided folder.
LoadEditorSettings
Loads the previously saved editor settings from the default location.
Overwrites any current settings.
LoadProjectSettings
Loads the previously saved project settings from the default location within the active project.
Loads default settings if no project is active. Overwrites any current settings.