Api
Classes
Project
chevron_left Classes
class
Project

Constructors

functionsProject

Properties

data_objectActivedata_objectBrokendata_objectConfigdata_objectConfigFilePathdata_objectEditUrldata_objectHasCompilerdata_objectIsBuiltIndata_objectIsPublisheddata_objectIsReadOnlydata_objectIsTransientdata_objectLastOpeneddata_objectPackagedata_objectPinneddata_objectRootDirectorydata_objectViewUrl

Methods

functionsGetAssetsPathfunctionsGetCodePathfunctionsGetEditorPathfunctionsGetLocalizationPathfunctionsGetProjectPathfunctionsGetRootPathfunctionsHasAssetsPathfunctionsHasCodePathfunctionsHasEditorPathfunctionsIsSourcePublish

Static Properties

data_objectCurrent

Static Methods

functionsGetAssetsfunctionsLoad
Project
Represents an on-disk project.
class Sandbox .
sealedSandbox.Engine

build Constructors 1

Project (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.

data_object Properties 15

Active
bool
True if this project is active
Broken
bool
True if this project failed to load properly for some reason
Config
ProjectConfig
Configuration of the project.
ConfigFilePath
string
Absolute path to the .addon file
EditUrl
string
The URL to the package's page for editing
HasCompiler
bool
Whether the project's code has a compiler assigned.
IsBuiltIn
bool
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.
IsPublished
bool
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.
IsReadOnly
bool
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.
IsTransient
bool
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.
LastOpened
DateTimeOffset
When did the user last open this project?
Package
Package
The package for this project. This is a mock up of the actual package.
Pinned
bool
True if this project is pinned, we'll prioritise it when sorting
RootDirectory
DirectoryInfo
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.
ViewUrl
string
The URL to the package's page for viewing/linking

functions Methods 10

GetAssetsPath ()
string
Absolute path to the Assets folder of the project, or if not set.
GetCodePath ()
string
Absolute path to the Code folder of the project.
GetEditorPath ()
string
Absolute path to the Editor folder of the project.
GetLocalizationPath ()
string
Absolute path to the Localization folder of the project, or if not set.
GetProjectPath ()
string
Gets the .sbproj file for this project
GetRootPath ()
string
Absolute path to the location of the .sbproj file of the project.
HasAssetsPath ()
bool
Returns true if the Assets path exists
HasCodePath ()
bool
Returns true if the Code path exists
HasEditorPath ()
bool
Returns true if the Editor path exists
IsSourcePublish ()
bool
Return true if this project type uploads all the source files when it's published

data_object Static Properties 1

Current
Project
Current open project.

functions Static Methods 2

GetAssets (project)
Asset[]
Get all assets in this project
Load (dir)
Project
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.