Class ProjectInfo

Contains information about Flax project.

ProjectInfo
Assembly: FlaxEngine.dll
File: Editor/ProjectInfo.h
Syntax
public class ProjectInfo

Constructors

ProjectInfo()

Declaration
public ProjectInfo()

Fields

Company

The project publisher company.

Declaration
public String Company
Field Value
String

DefaultScene

The default scene asset identifier to open on project startup.

Declaration
public Guid DefaultScene
Field Value
Guid

DefaultSceneSpawn

The default scene spawn point (position and view direction).

Declaration
public Ray DefaultSceneSpawn
Field Value
Ray

EditorTarget

The name of the build target to use for the game in editor building (editor game code).

Declaration
public String EditorTarget
Field Value
String

EngineNickname

The user-friendly nickname of the engine installation to use when opening the project. Can be used to open game project with a custom engine distributed for team members. This value must be the same in engine and game projects to be paired.

Declaration
public String EngineNickname
Field Value
String

GameTarget

The name of the build target to use for the game building (final, cooked game code).

Declaration
public String GameTarget
Field Value
String

MinEngineVersion

The minimum version supported by this project.

Declaration
public ::Version MinEngineVersion
Field Value
::Version

Name

The project name.

Declaration
public String Name
Field Value
String

ProjectFolderPath

The project root folder path.

Declaration
public String ProjectFolderPath
Field Value
String

ProjectPath

The absolute path to the project file.

Declaration
public String ProjectPath
Field Value
String

ProjectsCache

The loaded projects cache.

Declaration
public static Array<ProjectInfo* > ProjectsCache
Field Value
Array<ProjectInfo >

References

The project references.

Declaration
public Array<Reference> References
Field Value
Array<Reference>

Version

The project version.

Declaration
public ::Version Version
Field Value
::Version

Methods

GetAllProjects(HashSet<ProjectInfo* >& result)

Gets all projects including this project, it's references and their references (any deep level of references).

Declaration
public void GetAllProjects(HashSet<ProjectInfo* >& result)
Parameters
HashSet<ProjectInfo > result

The result list of projects (this and all references).

Load(const String& path)

Loads the project from the specified file.

Declaration
public static ProjectInfo* Load(const String& path)
Parameters
String path

The path.
Returns
ProjectInfo

The loaded project.

LoadOldProject(const String& projectPath)

Loads the old project file (Project.xml). [Deprecated: 16.04.2020, expires 16.04.2021]

Declaration
public bool LoadOldProject(const String& projectPath)
Parameters
String projectPath

The absolute path to the file with a project.
Returns
bool

True if cannot load it, otherwise false.

LoadProject(const String& projectPath)

Loads the project file (*.flaxproj).

Declaration
public bool LoadProject(const String& projectPath)
Parameters
String projectPath

The absolute path to the file with a project.
Returns
bool

True if cannot load it, otherwise false.

SaveProject()

Saves the project file (*.flaxproj).

Declaration
public bool SaveProject()
Returns
bool

True if cannot save it, otherwise false.