The Project class in the Sandbox namespace represents an on-disk project. It provides various methods and properties to access and manage different aspects of a project, such as its paths, configuration, and status.
The Project class in the Sandbox namespace represents an on-disk project. It provides various methods and properties to access and manage different aspects of a project, such as its paths, configuration, and status.
| Member Name | Summary |
|---|---|
| Load | Loads a project from the specified directory. |
| Current | Current open project. |
| Member Name | Summary |
|---|---|
| GetRootPath | Absolute path to the location of the .sbproj file of the project. |
| GetCodePath | Absolute path to the code folder of the project. |
| HasCodePath | Returns true if the Code path exists. |
| GetAssetsPath | Absolute path to the assets folder of the project, or null if not set. |
| GetLocalizationPath | Absolute path to the localization folder of the project, or null if not set. |
| HasAssetsPath | Returns true if the Assets path exists. |
| IsSourcePublish | Return true if this project type uploads all the source files when it's published. |
| HasCompiler | Whether the project's code has a compiler assigned. |
| ConfigFilePath | Absolute path to the .addon file. |
| RootDirectory | Root directory of this project. |
| Active | True if this project is active. |
| Pinned | True if this project is pinned, we'll prioritise it when sorting. |
| LastOpened | When did the user last open this project? |
| Broken | True if this project failed to load properly for some reason. |
| IsPublished | Returns true if this project has previously been published. |
| EditUrl | The URL to the package's page for editing. |
| ViewUrl | The URL to the package's page for viewing/linking. |
| Config | Configuration of the project. |
| IsTransient | If true this project isn't a 'real' project. It's likely a temporary project created with the intention to configure and publish a single asset. |
| IsBuiltIn | If true this project isn't a 'real' project. It's likely a temporary project created with the intention to configure and publish a single asset. |
| Package | The package for this project. This is a mock up of the actual package. |