infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Classes
PackageInfo
chevron_left Classes
struct
PackageInfo

Properties

data_objectDefaultMapdata_objectGameSettingsdata_objectHasGameSettingsdata_objectIsDedicatedServerOnlydata_objectIsQuickPlaydata_objectIsStreamerGamedata_objectIsVrOnlydata_objectLaunchModedata_objectMapTargetdata_objectMaxPlayersdata_objectMinPlayersdata_objectNeedsMapdata_objectParentPackagedata_objectShowsChangeMapdata_objectShowsPlayerListdata_objectUsesCreateGameModal
PackageInfo
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.
struct Sandbox .
sealedSandbox.Engine

data_object Properties 16

DefaultMap
string
The map this game launches with by default, or empty if none is configured.
GameSettings
List`1
The configurable game settings shown in the create-game modal, or null if none are defined.
HasGameSettings
bool
Does this game define any configurable Sandbox.DataModel.GameSettings?
IsDedicatedServerOnly
bool
Is this game playable only on a dedicated server (Sandbox.PackageInfo.LaunchMode "dedicatedserveronly")?
IsQuickPlay
bool
Does this game launch straight into matchmaking (Sandbox.PackageInfo.LaunchMode "quickplay")?
IsStreamerGame
bool
Does this game opt into the streamer integration features (the stream connection button, etc.)?
IsVrOnly
bool
Can this game only be played in VR?
LaunchMode
string
The raw launch mode (e.g. "quickplay", "dedicatedserveronly", "launcher"), or "default".
MapTarget
string
The package whose maps this game pulls from, defaulting to the game's own ident.
MaxPlayers
int
The maximum number of players this game supports. Defaults to 1.
MinPlayers
int
The minimum number of players needed to start this game. Defaults to 1.
NeedsMap
bool
Does this game require a map to be chosen before it can launch?
ParentPackage
string
The ident of this package's parent package, or null if it has none.
ShowsChangeMap
bool
Should the pause menu offer a "change map" button? Defaults to false.
ShowsPlayerList
bool
Should the pause menu show the player list button? Defaults to true.
UsesCreateGameModal
bool
Should launching this game go through the create-game modal rather than starting directly?
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.