s&
newspaper
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
rocket
Discover Games
business_center
Workshop
sports_esports
Games
landscape
Maps
chair
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
docs
Docs
docs
Documentation
dashboard
Api Reference
school
Tutorials
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Classes
Project
chevron_left
Classes
class
Project
search
Constructors
functions
Project
Properties
data_object
Active
data_object
Broken
data_object
Config
data_object
ConfigFilePath
data_object
EditUrl
data_object
HasCompiler
data_object
IsBuiltIn
data_object
IsPublished
data_object
IsTransient
data_object
LastOpened
data_object
Package
data_object
Pinned
data_object
RootDirectory
data_object
ViewUrl
Methods
functions
GetAssetsPath
functions
GetCodePath
functions
GetEditorPath
functions
GetLocalizationPath
functions
GetProjectPath
functions
GetRootPath
functions
HasAssetsPath
functions
HasCodePath
functions
HasEditorPath
functions
IsSourcePublish
Static Properties
data_object
Current
Static Methods
functions
GetAssets
functions
Load
Project
Represents an on-disk project.
class
Sandbox
.
sealed
Sandbox.Engine
build
Constructors
1
Project
(
)
data_object
Properties
14
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.
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
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.