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
gamejamslive now

Game Jam III

Ends Fri 25 Sep
ThemeOne More Round

The jam is running. Build something, or play the entries.

£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
inputLog in with Steam chevron_leftChange Language
简体中文EnglishРусскийEspañolPortuguês-BrasilDeutsch日本語FrançaisPolskiTürkçe한국어PirateItalianoไทย繁體中文УкраїнськаČeštinaNederlandsMagyarDanskSuomiSvenskaNorskΕλληνικάRomânăБългарскиTiếng ViệtBahasa IndonesiaEspañol-Latinoaméricaالعربية
Api
Components
MapInstance
chevron_left Components
class
MapInstance

Constructors

functionsMapInstance

Properties

data_objectBoundsdata_objectComponentVersiondata_objectEnableCollisiondata_objectIsLoadeddata_objectMapNamedata_objectNoOrigindata_objectOnMapLoadeddata_objectOnMapUnloadeddata_objectUseMapFromLaunch

Methods

lockOnCreateObjectlockOnLoadlockOnTagsChangedlockOnUpdatefunctionsUnloadMap
MapInstance
Allows you to load a map into the Scene. This can be either a vpk or a scene map.
class Sandbox .account_tree extends Component
Sandbox.Engine

build Constructors 1

MapInstance ()

data_object Properties 9

Bounds
BBox
Get the world bounds of the map
ComponentVersion
int
EnableCollision
bool
IsLoaded
bool
True if the map is loaded
MapName
string
NoOrigin
bool
OnMapLoaded
Action
Called when the map has successfully loaded
OnMapUnloaded
Action
Called when the map has been unloaded
UseMapFromLaunch
bool

functions Methods 5

OnCreateObject (go, kv)
Override this to add components to a map object. Only called for map objects that are not implemented.
OnLoad (context)
Task
OnTagsChanged ()
OnUpdate ()
UnloadMap ()
Unload the current map.

Inheritance

Component
MapInstance
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