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
gamejams
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
CompileGroup
chevron_left Classes
class
CompileGroup

Constructors

functionsCompileGroup

Properties

data_objectAllowFastHotloaddata_objectBuildResultdata_objectCompilersdata_objectIsBuildingdata_objectNamedata_objectNeedsBuilddata_objectOnCompileFinisheddata_objectOnCompileStarteddata_objectOnCompileSuccessdata_objectPrintErrorsInConsoledata_objectReferenceProvider

Methods

functionsBuildAsyncfunctionsCreateCompilerfunctionsDisposefunctionsGetOrCreateCompilerfunctionsResetfunctionsWaitForCompile

Static Properties

data_objectSuppressBuildNotifications
CompileGroup
class Sandbox .
Sandbox.Compiling

build Constructors 1

CompileGroup (name)

data_object Properties 11

AllowFastHotload
bool
True if we want to use fast hotloading with this compile group
BuildResult
Results
Returns true if build was successful
Compilers
IEnumerable`1
The compilers within the group
IsBuilding
bool
Returns true if we are currently in the process of building
Name
string
The name of this compile group, for debugging/display purposes
NeedsBuild
bool
Returns true if we have compiles pending
OnCompileFinished
Action
Called when a compiling ends
OnCompileStarted
Action
Called when a compiling starts
OnCompileSuccess
Action
Called when a compile completes successfully. Can access the result from BuildResult.
PrintErrorsInConsole
bool
True if we want to print errors in the console when compiling
ReferenceProvider
ICompileReferenceProvider
Allows providing an external way to find references

functions Methods 6

BuildAsync ()
Task`1
Build the compilers
CreateCompiler (name, path, settings)
Compiler
Create a new compiler in this group.
Dispose ()
Shut everything down
GetOrCreateCompiler (name)
Compiler
Reset ()
Reset the compile group. Clear errors and outputs.
WaitForCompile (token)
Task

data_object Static Properties 1

SuppressBuildNotifications
bool
Build notifications start of suppressed until after startup proper. That way we don't get 4 build notification windows popping up on startup.
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