class Package

in global :: Sandbox

Represents an asset on Asset Party.

public bool IsRemote { get; }

Whether this is a remote or a locally installed package.

public Package.Organization Org { get; set; }

The owner of this package.

public string FullIdent { get; }

Full unique identity of this package.

public string Ident { get; set; }

Unique identity of this package within its organization..

public string Title { get; set; }

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

public string Summary { get; set; }

A short summary of the package.

public string Description { get; set; }

Full description of the package.

public string Thumb { get; set; }

Link to the thumbnail image of this package.

public string ThumbWide { get; }

Link to the thumbnail image of this package.

public string ThumbTall { get; }

Link to the thumbnail image of this package.

public string VideoThumb { get; set; }

Link to the thumbnail video of this package.

public int EngineVersion { get; set; }

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

public string[] Tags { get; set; }

List of tags for this package.

public string[] PackageReferences { get; set; }

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

public string[] EditorReferences { get; set; }

List of packages that this package depended on during editing.

public Package.Type PackageType { get; set; }

What kind of package it is.

public string TypeName { get; set; }

What kind of package it is.

public bool Public { get; set; }

Whether this package is public or hidden.

public bool Archived { get; set; }

Whether this package is archived or not.

public float FileSize { get; }

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.

public Package.PackageUsageStats Usage { get; set; }

Statistics for user interactions with this package

public int Favourited { get; set; }

Number of players who added this package to their favourites.

public int VotesUp { get; set; }

Number of players who voted this package up.

public int VotesDown { get; set; }

Number of players who voted this package down.

public string Source { get; set; }

Link to this package's sources, if set.

public int ApiVersion { get; set; }

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

public Package.Screenshot[] Screenshots { get; set; }

A list of screenshots

public bool IsFavourite { get; }

True if this asset is in our favourite list.

public bool CanEdit { get; }

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

public string Url { get; }

A link to this asset on our backend

public DateTimeOffset Updated { get; set; }

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

public DateTimeOffset Created { get; set; }

When the package was originally created.

public int Collections { get; set; }

How many collections we're in (roughly)

public int Referencing { get; set; }

How many packages we're referencing (roughly)

public int Referenced { get; set; }

How many packages we're referenced by (roughly)

public Package.ReviewStats Reviews { get; set; }

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

public float ErrorRate { get; set; }

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

public News LatestNewsPost { get; set; }

The latest news post created by this package

public Package.IRevision Revision { get; }

Information about the current package revision/version.

public Package.PackageInteraction Interaction { get; set; }

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.

public Package.LoadingScreenSetup LoadingScreen { get; set; }

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

public static Task<Package> FetchAsync( string identString, bool partial )

Find package information

public static Task<Package> FetchAsync( string identString, bool partial, bool useCache )

Find package information

public static bool TryGetCached( string identString, ref Package package, bool allowPartial = True )

Find package information

public static Task<Package> Fetch( string identString, bool partial )

Find package information

public static string GetCachedTitle( string ident )

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

public static Task<Package.FindResult> FindAsync( string query, int take = 200, int skip = 0, CancellationToken token = null )

Retrieve a list of packages

public static Task<Package.ListResult> ListAsync( int amountPerGroup, CancellationToken token = null )

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

public static Task<List<Package.IRevision>> FetchVersions( string identString, CancellationToken token = null )

Get package version list

public string ToString( )

😔 No documentation found.

public static IEnumerable<T> SortByReferences( IEnumerable<T> unordered, Func<T,Package> getPackageFunc )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public static IEnumerable<Package> SortByReferences( IEnumerable<Package> unordered )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public Package( )

😔 No documentation found.

public static bool TryParseIdent( string ident, ref ValueTuple<string,string,Nullable<int>,bool> parsed )

😔 No documentation found.

public T GetCachedMeta( string keyName, Func<T> defaultValue )

😔 No documentation found.

public T GetCachedMeta( string keyName, T defaultValue = null )

😔 No documentation found.

public T GetMeta( string keyName, T defaultValue = null )

😔 No documentation found.

public T GetValue( string name, T defaultValue = null )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public static string FormatIdent( string org, string package, Nullable<int> version = null, bool local = False )

😔 No documentation found.

public ValueTask<AchievementCollection> GetAchievements( )

😔 No documentation found.