PackageInfoclass
A thin readonly view over a `Sandbox.Package`'s data values, exposing the well-known launcher flags by name so callers don't repeat the string keys and defaults. Holds nothing but a reference to the package; get one from `Sandbox.Package.Info`. Tolerates a default/empty instance by returning each flag's default.
Properties16
Showing 16 properties
public string Sandbox.PackageInfo.DefaultMap { get; set; }
The map this game launches with by default, or empty if none is configured.
string—public System.Collections.Generic.List`1<Sandbox.DataModel.GameSetting> Sandbox.PackageInfo.GameSettings { get; set; }
The configurable game settings shown in the create-game modal, or null if none are defined.
public bool Sandbox.PackageInfo.HasGameSettings { get; set; }
Does this game define any configurable `Sandbox.DataModel.GameSetting`s?
bool—public bool Sandbox.PackageInfo.IsDedicatedServerOnly { get; set; }
Is this game playable only on a dedicated server (`Sandbox.PackageInfo.LaunchMode` "dedicatedserveronly")?
bool—public bool Sandbox.PackageInfo.IsQuickPlay { get; set; }
Does this game launch straight into matchmaking (`Sandbox.PackageInfo.LaunchMode` "quickplay")?
bool—public bool Sandbox.PackageInfo.IsStreamerGame { get; set; }
Does this game opt into the streamer integration features (the stream connection button, etc.)?
bool—public bool Sandbox.PackageInfo.IsVrOnly { get; set; }
Can this game only be played in VR?
bool—public string Sandbox.PackageInfo.LaunchMode { get; set; }
The raw launch mode (e.g. "quickplay", "dedicatedserveronly", "launcher"), or "default".
string—public string Sandbox.PackageInfo.MapTarget { get; set; }
The package whose maps this game pulls from, defaulting to the game's own ident.
string—public int Sandbox.PackageInfo.MaxPlayers { get; set; }
The maximum number of players this game supports. Defaults to 1.
int—public int Sandbox.PackageInfo.MinPlayers { get; set; }
The minimum number of players needed to start this game. Defaults to 1.
int—public bool Sandbox.PackageInfo.NeedsMap { get; set; }
Does this game require a map to be chosen before it can launch?
bool—public string Sandbox.PackageInfo.ParentPackage { get; set; }
The ident of this package's parent package, or null if it has none.
string—public bool Sandbox.PackageInfo.ShowsChangeMap { get; set; }
Should the pause menu offer a "change map" button? Defaults to false.
bool—public bool Sandbox.PackageInfo.ShowsPlayerList { get; set; }
Should the pause menu show the player list button? Defaults to true.
bool—public bool Sandbox.PackageInfo.UsesCreateGameModal { get; set; }
Should launching this game go through the create-game modal rather than starting directly?
bool—No results match this filter.