LoadingScreenclass

Holds metadata and raw data relating to a Saved Game.

object→LoadingScreen
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public static abstract sealed class Sandbox.LoadingScreen

Properties8

Showing 8 properties

public static System.Collections.Generic.IReadOnlyList`1<Sandbox.Menu.LoadingDownload> Sandbox.LoadingScreen.Downloads { get; set; }PUBLICSTATICGETSET

Every package downloaded for the load under way, in the order they became known - for one bar across all of them, rather than `Sandbox.LoadingScreen.Progress`'s one download at a time. Packages known in advance (a server's, the game and its map) are added with their sizes before anything starts downloading; anything found later is added as it starts. Cleared when the loading screen's shown or hidden.

Returns:IReadOnlyList<LoadingDownload>—

public static bool Sandbox.LoadingScreen.IsVisible { get; set; }PUBLICSTATICGETSET

Returns:bool—

public static string Sandbox.LoadingScreen.Media { get; set; }PUBLICSTATICGETSET

A URL or filepath to show as the background image.

Returns:string—

public static Sandbox.Package Sandbox.LoadingScreen.Package { get; set; }PUBLICSTATICGETSET

The game being loaded, once it's been looked up - so the loading screen can show its name, its art and what's new in it. Null before then, and when what's loading isn't a game. Cleared when the loading screen is hidden.

Returns:Package—

public static System.Nullable`1<Sandbox.Menu.LoadingProgress> Sandbox.LoadingScreen.Progress { get; set; }PUBLICSTATICGETSET

A snapshot of the current download's progress, or null when progress is unavailable. Cleared when the loading screen is hidden.

Returns:Nullable<LoadingProgress>—

public static string Sandbox.LoadingScreen.Subtitle { get; set; }PUBLICSTATICGETSET

A subtitle to show

Returns:string—

public static System.Collections.Generic.List`1<Sandbox.LoadingContext> Sandbox.LoadingScreen.Tasks { get; set; }PUBLICSTATICGETSET

A list of tasks that are currently being awaited during loading.

Returns:List<LoadingContext>—

public static string Sandbox.LoadingScreen.Title { get; set; }PUBLICSTATICGETSET

A title to show

Returns:string—

On this page