s&box

build Constructors 1

data_object Properties 42

For game extension compatibility. Game targeting extensions are only compatible with that game if the API Versions match.

Whether this package is archived or not.

True if we're a member of this package's organization.

How many collections we're in (roughly)

When the package was originally created.

Full description of the package.

EditorReferences

List of packages that this package depended on during editing.

Engine version this package was uploaded with. This is useful for when the base game undergoes large API changes.

What fraction of users got errors from this package in the last day

Number of players who added this package to their favourites.

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.

Full unique identity of this package.

Unique identity of this package within its organization..

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.

True if this asset is in our favourite list.

Whether this is a remote or a locally installed package.

The latest news post created by this package

LoadingScreenSetup

If this package is a game, it can provide media to show on the loading screen

The owner of this package.

PackageReferences

List of packages that this package depends on. These will be downloaded and installed when installing this package.

What kind of package it is.

Gets the name of the primary asset path stored in the package metadata. This could be null or empty.

Whether this package is public or hidden.

How many packages we're referenced by (roughly)

How many packages we're referencing (roughly)

Stats for the reviews. Gives the number of reviews, and the fraction of the total score.

Information about the current package revision/version.

A list of screenshots

Link to this package's sources, if set.

A short summary of the package.

List of tags for this package.

Link to the thumbnail image of this package.

Link to the thumbnail image of this package.

Link to the thumbnail image of this package.

A "nice" name of this package, which will be shown to players in UI.

What kind of package it is.

When the entry was last updated. If these are different between packages then something updated on the backend.

A link to this asset on our backend

PackageUsageStats

Statistics for user interactions with this package

Link to the thumbnail video of this package.

Number of players who voted this package down.

Number of players who voted this package up.

functions Methods 6

GetAchievements ()

Get a list of achievements

GetCachedMeta (keyName, defaultValue)

Sandbox.Package.GetMeta``1(System.String,``0) but with cache.

GetMeta (keyName, defaultValue)

Get metadata value from this package for given key. This will be specific to each Sandbox.Package.Type.

GetValue (name, defaultValue)

Get a data value. These are usually set on the backend, and are package type specific. These are generally values that are used to configure behaviour in the menu system.

Check if the package is installed and mounted

MountAsync (withCode)

Download and mount this package. If withCode is true we'll try to load the assembly if it exists.

functions Static Methods 14

Fetch (identString, partial)

Find package information

FetchAsync (identString, partial)

Find package information

FetchVersions (identString, token)

Get package version list

FindAsync (query, take, skip, token)

Retrieve a list of packages

FormatIdent (org, package, version, local)

GetCachedTitle (ident)

If we have this package information, try to get its name

ListAsync (id, token)

Retrieve a list of packages, organised into groups, for discovery

SetFavouriteAsync (package, state)

Mark this package as a favourite

SetVoteAsync (package, up)

Add your vote for this package

SortByReferences (unordered)

TryGetCached (identString, package, allowPartial)

Find package information

TryParseIdent (ident, parsed)

UpdateValue (package, key, value, token)

Update a value on this package

UploadFile (package, absolutePath, relativePath, progress, token)

Mark this package as a favourite

people

Log in to reply

You can't reply if you're not logged in. That would be crazy.