WorkshopDownloadclass

A workshop item coming down, or one that's ended - for the menu to show. One that ended failed if there's an `Sandbox.WorkshopDownload.Error`, saying what went wrong, with `Sandbox.WorkshopDownload.ErrorHelp` what to do about it; otherwise it finished.

object→WorkshopDownload
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.WorkshopDownload

Constructors1

Showing 1 constructors

public WorkshopDownload(ulong Id, string Title, string Thumb, long Downloaded, long Total, string Error = null, string ErrorHelp = null)PUBLICCONSTRUCTOR

A workshop item coming down, or one that's ended - for the menu to show. One that ended failed if there's an `Sandbox.WorkshopDownload.Error`, saying what went wrong, with `Sandbox.WorkshopDownload.ErrorHelp` what to do about it; otherwise it finished.

ParameterTypeDescription
IdulongThe item's workshop id
TitlestringWhat it's called
ThumbstringIts preview image
DownloadedlongHow much of it's come down, in bytes
TotallongHow much there is to come down, in bytes
Error = nullstringWhat went wrong, if it failed
ErrorHelp = nullstringWhat to do about it

Methods1

Showing 1 methods

public void Deconstruct(ulong Id, string Title, string Thumb, long Downloaded, long Total, string Error, string ErrorHelp)PUBLIC

ParameterTypeDescription
Idulong—
Titlestring—
Thumbstring—
Downloadedlong—
Totallong—
Errorstring—
ErrorHelpstring—
Returns:void—

Properties8

Showing 8 properties

public long Sandbox.WorkshopDownload.Downloaded { get; set; }PUBLICGETSET

How much of it's come down, in bytes

Returns:long—

public string Sandbox.WorkshopDownload.Error { get; set; }PUBLICGETSET

What went wrong, if it failed

Returns:string—

public string Sandbox.WorkshopDownload.ErrorHelp { get; set; }PUBLICGETSET

What to do about it

Returns:string—

public float Sandbox.WorkshopDownload.Fraction { get; set; }PUBLICGETSET

How far through it is, 0 to 1

Returns:float—

public ulong Sandbox.WorkshopDownload.Id { get; set; }PUBLICGETSET

The item's workshop id

Returns:ulong—

public string Sandbox.WorkshopDownload.Thumb { get; set; }PUBLICGETSET

Its preview image

Returns:string—

public long Sandbox.WorkshopDownload.Total { get; set; }PUBLICGETSET

How much there is to come down, in bytes

Returns:long—

On this page