API ReferenceSandbox.Menu

LoadingDownloadclass

One package being downloaded for the load that's under way - an entry in `Sandbox.LoadingScreen.Downloads`, so a loading screen can show all of a load's downloads as one bar.

object→LoadingDownload
Namespace
Sandbox.Menu
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Menu.LoadingDownload

Constructors1

Showing 1 constructors

Properties7

Showing 7 properties

public long Sandbox.Menu.LoadingDownload.Downloaded { get; set; }PUBLICGETSET

How much of `Sandbox.Menu.LoadingDownload.TotalSize` has come down.

Returns:long—

public double Sandbox.Menu.LoadingDownload.Fraction { get; set; }PUBLICGETSET

How far through it is, 0 to 1.

Returns:double—

public string Sandbox.Menu.LoadingDownload.Ident { get; set; }PUBLICGETSET

The package's full ident, without a version.

Returns:string—

public bool Sandbox.Menu.LoadingDownload.IsComplete { get; set; }PUBLICGETSET

Returns:bool—

public double Sandbox.Menu.LoadingDownload.Mbps { get; set; }PUBLICGETSET

Its transfer rate right now, in megabits a second. 0 when it isn't transferring.

Returns:double—

public long Sandbox.Menu.LoadingDownload.TotalSize { get; set; }PUBLICGETSET

What it'll fetch, in bytes - reserved up front when it's known in advance, exact once the download starts. 0 when it's all in the download cache already and there's nothing to fetch.

Returns:long—

On this page