Api Sandbox Project
class

Project

public sealed class Project

Represents an on-disk project.

Constructors

Project()

Properties

Name Type Description
HasCompiler Boolean Whether the project's code has a compiler assigned.
ConfigFilePath String Absolute path to the .addon file
RootDirectory DirectoryInfo Root directory of this project
Active Boolean True if this project is active
Pinned Boolean True if this project is pinned, we'll prioritise it when sorting
LastOpened DateTimeOffset When did the user last open this project?
Broken Boolean True if this project failed to load properly for some reason
IsPublished Boolean Returns true if this project has previously been published. This is kind of a guess though because all it does is look to see if we have a published package cached with the same ident.
EditUrl String The URL to the package's page for editing
ViewUrl String The URL to the package's page for viewing/linking
Config ProjectConfig Configuration of the project.
IsTransient Boolean 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 Boolean 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 Package The package for this project. This is a mock up of the actual package.
Current static Project Current open project.

Methods

String GetRootPath()

Absolute path to the location of the .sbproj file of the project.

String GetProjectPath()

Gets the .sbproj file for this project

String GetCodePath()

Absolute path to the Code folder of the project.

Boolean HasCodePath()

Returns true if the Code path exists

String GetEditorPath()

Absolute path to the Editor folder of the project.

Boolean HasEditorPath()

Returns true if the Editor path exists

String GetAssetsPath()

Absolute path to the Assets folder of the project, or if not set.

String GetLocalizationPath()

Absolute path to the Localization folder of the project, or if not set.

Boolean HasAssetsPath()

Returns true if the Assets path exists

Boolean IsSourcePublish()

Return true if this project type uploads all the source files when it's published

static Project Load(String dir)
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.Project