Class Editor
Main editor class
Inheritance
Assembly: FlaxEngine.dll
File: Editor/Editor.h
Syntax
public class Editor : public ApplicationBaseFields
IsOldProjectOpened
The flag used to determine if a project was used with the older engine version last time it was opened. Some cached data should be regenerated to prevent version difference issues. The version number comparison is based on major and minor part of the version. Build number is ignored.
Declaration
public static bool IsOldProjectOpenedField Value
|
bool
|
IsPlayMode
True if the editor is running now in a play mode. Assigned by the managed editor instance.
Declaration
public static bool IsPlayModeField Value
|
bool
|
LastProjectOpenedEngineBuild
The build number of the last editor instance that opened the current project. Value 0 means the undefined version.
Declaration
public static int32 LastProjectOpenedEngineBuildField Value
|
int32
|
Managed
The managed editor object.
Declaration
public static ManagedEditor* ManagedField Value
|
ManagedEditor
|
Project
Information about the loaded game project.
Declaration
public static ProjectInfo* ProjectField Value
|
ProjectInfo
|
Methods
BackupProject()
Backups the whole project (all files) to the separate directory.
Declaration
public static bool BackupProject()Returns
|
bool
True if failed, otherwise false. |
BeforeExit()
Declaration
public static void BeforeExit()BeforeRun()
Declaration
public static void BeforeRun()CheckProjectUpgrade()
Checks if the project upgrade is required and may perform it. Will update IsOldProjectOpened flag.
Declaration
public static bool CheckProjectUpgrade()Returns
|
bool
True if engine should exit, otherwise false. |
CloseSplashScreen()
Closes the splash screen window (if visible).
Declaration
public static void CloseSplashScreen()CreateMainWindow()
Declaration
public static Window* CreateMainWindow()Returns
|
Window
|
Init()
Declaration
public static bool Init()Returns
|
bool
|
LoadProduct()
Declaration
public static int32 LoadProduct()Returns
|
int32
|