s&
About
The Project
infoAbout s&box mapRoadmap monitoringMetricsEngine startup and usage numbers
Updates
newspaperLatest News published_with_changesChangesRelease-by-release changelog
Games
Browse Games Discover Games
gamejamsvoting

Game Jam III

Ends Fri 25 Sep
ThemeOne More Round

Voting is open. Play the entries and pick the winner.

£50,000
prizepool
View the jam
Workshop
Playable
sports_esportsGamesStandalone games and gamemodes
Assets
landscapeMaps view_in_arModels textureMaterials apparelClothing
appsEverythingEvery asset type in one list
Forum
Learn
Documentation
rocket_launchGetting Started docsDocumentation apiAPI Reference
Resources
schoolTutorials manage_searchCode Search
Get s&box
Sign in with Steam
Api
Classes
MapSettings
chevron_left Classes
class
MapSettings

Constructors

functionsMapSettings

Properties

data_objectDefaultMapdata_objectMapTargetdata_objectNeedsMapdata_objectShowChangeMapdata_objectUseCreateGameModal
MapSettings
How the menu launches a game with maps. Stored in the project meta under "MapSettings".
class Sandbox .
Sandbox.Engine

build Constructors 1

MapSettings ()

data_object Properties 5

DefaultMap
string
The map package selected by default, e.g. facepunch.flatgrass. Leave empty to make players choose.
MapTarget
string
Leave empty to show maps made for this game. Or list the games whose maps you can load, e.g. facepunch.sandbox, facepunch.walker - or * for all maps.
NeedsMap
bool
Players have to choose a map before they can play.
ShowChangeMap
bool
Show a Change Map option in the escape menu. Relaunches the game with the new map.
UseCreateGameModal
bool
When pressing play, show a popup to configure max players, lobby privacy and the map.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.
Facepunch
  • News
  • Docs
  • Metrics
  • FAQ
  • Forum
  • Discord
  • Twitter