s&
About
The Project
info
About s&box
map
Roadmap
monitoring
Metrics
Engine startup and usage numbers
Updates
newspaper
Latest News
published_with_changes
Changes
Release-by-release changelog
Games
Browse Games
Discover Games
gamejams
Workshop
Playable
sports_esports
Games
Standalone games and gamemodes
Assets
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
apps
Everything
Every asset type in one list
Forum
Learn
Documentation
rocket_launch
Getting Started
docs
Documentation
api
API Reference
Resources
school
Tutorials
manage_search
Code Search
Get s&box
Sign in with Steam
Api
Editor Classes
PackageManifest
chevron_left
Editor Classes
class
PackageManifest
Constructors
functions
PackageManifest
Fields
crop_din
Errors
Properties
data_object
Assets
data_object
CodeAssetWarnings
data_object
CodePackageReferences
data_object
Description
data_object
ExcludedAssets
data_object
ExcludedAssetSizes
data_object
ExcludedByRules
data_object
ExclusionOverrides
data_object
IncludedExclusionReasons
data_object
IncludeSourceFiles
data_object
IsPreview
data_object
RecommendedIncludes
data_object
RecommendedRules
data_object
SceneWarnings
data_object
Summary
Methods
functions
AddTextFile
functions
BuildFromAssets
functions
BuildFromSource
functions
FindAsset
functions
GetDependencySummary
functions
GetEstimateIssues
functions
GetInclusionReasons
functions
GetPublishFootprint
functions
GetPublishImpact
functions
ToJson
Static Fields
crop_din
DissallowedExtensions
Static Methods
functions
AddResourceRules
functions
CleanResourceRules
functions
LooseFileAllowed
functions
SetResourceRules
PackageManifest
class
Editor.ProjectPublisher
.
Sandbox.Tools
build
Constructors
1
PackageManifest
(
)
crop_din
Fields
1
Errors
List`1
data_object
Properties
15
Assets
List`1
CodeAssetWarnings
List`1
CodePackageReferences
HashSet`1
List of packages that the code references
Description
string
ExcludedAssets
List`1
ExcludedAssetSizes
Dictionary`2
ExcludedByRules
Dictionary`2
ExclusionOverrides
List`1
IncludedExclusionReasons
Dictionary`2
IncludeSourceFiles
bool
IsPreview
bool
Preview files have sizes but no upload hashes. They must be rebuilt before uploading.
RecommendedIncludes
String[]
Exact excluded files mentioned by literal paths in code, unless explicitly excluded by a rule.
RecommendedRules
String[]
SceneWarnings
List`1
Summary
string
functions
Methods
10
AddTextFile
(
contents
,
relativePath
)
Task
BuildFromAssets
(
project
,
progress
,
cancel
,
options
,
previewOnly
)
Task
BuildFromSource
(
addon
,
progress
,
cancel
)
Task
FindAsset
(
relativePath
)
ProjectFile
GetDependencySummary
(
paths
)
DependencySummary
GetEstimateIssues
(
)
IReadOnlyList`1
The actual gaps behind incomplete estimates, reported once for the whole preview.
GetInclusionReasons
(
paths
)
String[]
GetPublishFootprint
(
paths
)
PublishImpact
GetPublishImpact
(
paths
)
PublishImpact
ToJson
(
)
string
crop_din
Static Fields
1
DissallowedExtensions
String[]
This really exists only to dissallow dangerous extensions like .exe etc. So feel free to add anything non dangerous to this list.
functions
Static Methods
4
AddResourceRules
(
rules
,
additions
)
string
CleanResourceRules
(
rules
)
ResourceRuleCleanup
Remove provably redundant rules, preserving the matched file set, comments and order.
LooseFileAllowed
(
file
,
allowSourceFiles
)
bool
SetResourceRules
(
project
,
rules
)
Save publishing rules from editor addons without forcing a code compilation.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.