Class ProjectInfo

Contains information about Flax project.

System.Object
ProjectInfo
Namespace: FlaxEditor
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class ProjectInfo : Object

Constructors

ProjectInfo()

Declaration
public ProjectInfo()

Fields

Company

The project publisher company.

Declaration
public string Company
Field Value
System.String

DefaultScene

The default scene asset identifier to open on project startup.

Declaration
public string DefaultScene
Field Value
System.String

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
System.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
System.String

GameTarget

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

Declaration
public string GameTarget
Field Value
System.String

MinEngineVersion

The minimum version supported by this project.

Declaration
public Version MinEngineVersion
Field Value
System.Version

Name

The project name.

Declaration
public string Name
Field Value
System.String

ProjectFolderPath

The project root folder path.

Declaration
public string ProjectFolderPath
Field Value
System.String

ProjectPath

The project file path.

Declaration
public string ProjectPath
Field Value
System.String

References

The project references.

Declaration
public ProjectInfo.Reference[] References
Field Value
ProjectInfo.Reference[]

Version

The project version.

Declaration
public Version Version
Field Value
System.Version

Methods

GetAllProjects()

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

Declaration
public HashSet<ProjectInfo> GetAllProjects()
Returns
System.Collections.Generic.HashSet<ProjectInfo>

The collection of projects.

Load(String)

Loads the project from the specified file.

Declaration
public static ProjectInfo Load(string path)
Parameters
System.String path

The path.
Returns
ProjectInfo

The loaded project.

Save()

Saves the project file.

Declaration
public void Save()

ToString()

Declaration
public override string ToString()
Returns
System.String

Extension Methods