Projectclass
Represents an on-disk project.
Constructors1
Showing 1 constructors
public Project(string configFilePath)
A project from its .sbproj on disk. Everything about where the project lives comes from this path, so a project can't be pointed somewhere else once it exists.
| Parameter | Type | Description |
|---|---|---|
| configFilePath | string | — |
No results match this filter.
Methods11
Showing 11 methods
public string GetAssetsPath()
Absolute path to the Assets folder of the project, or if not set.
string—public string GetCodePath()
Absolute path to the Code folder of the project.
string—public string GetEditorPath()
Absolute path to the Editor folder of the project.
string—public string GetLocalizationPath()
Absolute path to the Localization folder of the project, or if not set.
string—public string GetProjectPath()
Gets the .sbproj file for this project
string—public string GetRootPath()
Absolute path to the location of the `.sbproj` file of the project.
string—public bool HasAssetsPath()
Returns true if the Assets path exists
bool—public bool HasCodePath()
Returns true if the Code path exists
bool—public bool HasEditorPath()
Returns true if the Editor path exists
bool—public bool IsSourcePublish()
Return true if this project type uploads all the source files when it's published
bool—No results match this filter.
Properties16
Showing 16 properties
public bool Sandbox.Project.Active { get; set; }
True if this project is active
bool—public bool Sandbox.Project.Broken { get; set; }
True if this project failed to load properly for some reason
bool—public Sandbox.DataModel.ProjectConfig Sandbox.Project.Config { get; set; }
Configuration of the project.
public string Sandbox.Project.ConfigFilePath { get; set; }
Absolute path to the .addon file
string—public string Sandbox.Project.EditUrl { get; set; }
The URL to the package's page for editing
string—public bool Sandbox.Project.HasCompiler { get; set; }
Whether the project's code has a compiler assigned.
bool—public bool Sandbox.Project.IsBuiltIn { get; set; }
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.
bool—public bool Sandbox.Project.IsPublished { get; set; }
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.
bool—public bool Sandbox.Project.IsReadOnly { get; set; }
If true this project's config didn't come from a .sbproj on disk and is never written back to one. An exported standalone game is one of these: its config is embedded in the executable and its install folder is not ours to write to.
bool—public bool Sandbox.Project.IsTransient { get; set; }
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.
bool—public System.DateTimeOffset Sandbox.Project.LastOpened { get; set; }
When did the user last open this project?
DateTimeOffset—public Sandbox.Package Sandbox.Project.Package { get; set; }
The package for this project. This is a mock up of the actual package.
public bool Sandbox.Project.Pinned { get; set; }
True if this project is pinned, we'll prioritise it when sorting
bool—public System.IO.DirectoryInfo Sandbox.Project.RootDirectory { get; set; }
Root directory of this project, the folder its `Sandbox.Project.ConfigFilePath` sits in. Fixed when the project is created, along with the filesystems rooted in it.
DirectoryInfo—public string Sandbox.Project.ViewUrl { get; set; }
The URL to the package's page for viewing/linking
string—No results match this filter.