Projectclass

Represents an on-disk project.

objectProject
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Project

Constructors1

Showing 1 constructors

Methods11

Showing 11 methods

public string GetAssetsPath()PUBLIC

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

Returns:string

public string GetCodePath()PUBLIC

Absolute path to the Code folder of the project.

Returns:string

public string GetEditorPath()PUBLIC

Absolute path to the Editor folder of the project.

Returns:string

public string GetLocalizationPath()PUBLIC

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

Returns:string

public string GetProjectPath()PUBLIC

Gets the .sbproj file for this project

Returns:string

public string GetRootPath()PUBLIC

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

Returns:string

public bool HasAssetsPath()PUBLIC

Returns true if the Assets path exists

Returns:bool

public bool HasCodePath()PUBLIC

Returns true if the Code path exists

Returns:bool

public bool HasEditorPath()PUBLIC

Returns true if the Editor path exists

Returns:bool

public bool IsSourcePublish()PUBLIC

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

Returns:bool

public static Sandbox.Project Load(string dir)PUBLICSTATIC

ParameterTypeDescription
dirstring
Returns:Project

Properties15

Showing 15 properties

public bool Sandbox.Project.Active { get; set; }PUBLICGETSET

True if this project is active

Returns:bool

public bool Sandbox.Project.Broken { get; set; }PUBLICGETSET

True if this project failed to load properly for some reason

Returns:bool

public string Sandbox.Project.ConfigFilePath { get; set; }PUBLICGETSET

Absolute path to the .addon file

Returns:string

public static Sandbox.Project Sandbox.Project.Current { get; set; }PUBLICSTATICGETSET

Current open project.

Returns:Project

public string Sandbox.Project.EditUrl { get; set; }PUBLICGETSET

The URL to the package's page for editing

Returns:string

public bool Sandbox.Project.HasCompiler { get; set; }PUBLICGETSET

Whether the project's code has a compiler assigned.

Returns:bool

public bool Sandbox.Project.IsBuiltIn { get; set; }PUBLICGETSET

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.

Returns:bool

public bool Sandbox.Project.IsPublished { get; set; }PUBLICGETSET

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.

Returns:bool

public bool Sandbox.Project.IsTransient { get; set; }PUBLICGETSET

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.

Returns:bool

public System.DateTimeOffset Sandbox.Project.LastOpened { get; set; }PUBLICGETSET

When did the user last open this project?

Returns:DateTimeOffset

public Sandbox.Package Sandbox.Project.Package { get; set; }PUBLICGETSET

The package for this project. This is a mock up of the actual package.

Returns:Package

public bool Sandbox.Project.Pinned { get; set; }PUBLICGETSET

True if this project is pinned, we'll prioritise it when sorting

Returns:bool

public System.IO.DirectoryInfo Sandbox.Project.RootDirectory { get; set; }PUBLICGETSET

Root directory of this project

Returns:DirectoryInfo

public string Sandbox.Project.ViewUrl { get; set; }PUBLICGETSET

The URL to the package's page for viewing/linking

Returns:string

On this page