build Constructors 1

data_object Properties 47

ApiVersion
int
For game extension compatibility. Game targeting extensions are only compatible with that game if the API Versions match.
Archived
bool
Whether this package is archived or not.
AssetLicense
string
The license covering this package's art/content assets, identified by name (e.g. "CC0", "CC_BY"). Null when no license is specified. Matches PackageLicense.Name in the license catalog, so it can be used to look up the full license details.
CanEdit
bool
True if we're a member of this package's organization.
Collections
int
How many collections we're in (roughly)
Created
DateTimeOffset
When the package was originally created.
Description
string
Full description of the package.
EditorReferences
String[]
List of packages that this package depended on during editing.
EngineVersion
int
Engine version this package was uploaded with. This is useful for when the base game undergoes large API changes.
ErrorRate
float
What fraction of users got errors from this package in the last day
Favourited
int
Number of players who added this package to their favourites.
FileSize
float
The total size of this package in MB. This only applies to packages from Asset Party, the total file size of local packages are not calculated.
Flair
ImmutableArray`1
Small icon badges shown over the package's thumbnail - workshop-approved, updated-since-you-played, favourited, contest-winner, etc. Computed on the backend when the package is served. Never default; empty when there's no flair.
FullIdent
string
Full unique identity of this package.
Ident
string
Unique identity of this package within its organization..
Info
PackageInfo
Strongly-typed shortcuts for the well-known data values the menu/launcher reads via Sandbox.Package.GetValue``1(System.String,``0). Sandbox.PackageInfo is a thin readonly view over this package, so package.Info.IsStreamerGame allocates nothing and keeps the magic string keys and their defaults in one place.
Interaction
PackageInteraction
Describes the authenticated user's interactions with this package. This is only available clientside for specific users in order to show things like play history state, favourite status and whether they have rated the item or not.
IsFavourite
bool
True if this asset is in our favourite list.
IsRemote
bool
Whether this is a remote or a locally installed package.
LatestChangeLists
ImmutableArray`1
The most recent visible changelists for this package (summary only - id/title/version/date). Full detail is available via Sandbox.Package.GetChangeListsAsync(System.Int32). Never default; empty when there are none.
LatestNewsPost
News
The latest news post created by this package
LoadingScreen
LoadingScreenSetup
If this package is a game, it can provide media to show on the loading screen
Metadata
AssetMetaData
Server-extracted metadata for the current version's compiled asset (model stats, material flags, clothing info, ...). Null if the version hasn't been processed or its type isn't recognised. Pattern-match the concrete type, e.g. if ( package.Metadata is Package.ModelMetaData m ).
Org
Organization
The owner of this package.
PackageReferences
String[]
List of packages that this package depends on. These will be downloaded and installed when installing this package.
PackageType
obsoleteType
What kind of package it is.
PrimaryAsset
string
Gets the name of the primary asset path stored in the package metadata. This could be null or empty.
Public
bool
Whether this package is public or hidden.
Referenced
int
How many packages we're referenced by (roughly)
Referencing
int
How many packages we're referencing (roughly)
Reviews
ReviewStats
Stats for the reviews. Gives the number of reviews, and the fraction of the total score.
Revision
IRevision
Information about the current package revision/version.
Screenshots
Screenshot[]
A list of screenshots
Source
obsoletestring
Link to this package's sources, if set.
Summary
string
A short summary of the package.
Tags
String[]
List of tags for this package.
Thumb
string
Link to the thumbnail image of this package.
ThumbTall
string
Link to the thumbnail image of this package.
ThumbWide
string
Link to the thumbnail image of this package.
Title
string
A "nice" name of this package, which will be shown to players in UI.
TypeName
string
What kind of package it is.
Updated
DateTimeOffset
When the entry was last updated. If these are different between packages then something updated on the backend.
Url
string
A link to this asset on our backend
Usage
PackageUsageStats
Statistics for user interactions with this package
VideoThumb
string
Link to the thumbnail video of this package.
VotesDown
int
Number of players who voted this package down.
VotesUp
int
Number of players who voted this package up.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.