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
Api
Classes
ResourceCompiler
chevron_left Classes
class
ResourceCompiler

Constructors

lockResourceCompiler

Properties

data_objectContext

Methods

lockCompilelockCompileEmbeddedlockCompileEmbeddedResourcelockCreateGeneratedResourcePathlockTryParseEmbeddedResourcelockWriteToJson
ResourceCompiler
Takes the "source" of a resource and creates a compiled version. The compiled version can create a number of child resources and store binary data.
class Sandbox.Resources .
abstractSandbox.Engine

build Constructors 1

ResourceCompiler ()

data_object Properties 1

Context
ResourceCompileContext

functions Methods 6

Compile ()
Task`1
CompileEmbedded (json)
bool
CompileEmbeddedResource (embed, subfolder, extension, fs)
bool
Generic method to compile an embedded resource by creating a child context. This handles the common pattern of creating a generator, generating a path, creating a child context, and setting the compiled path.
CreateGeneratedResourcePath (embed, subfolder, extension)
string
Create a deterministic path for a generated resource based on the embedded resource data.
TryParseEmbeddedResource (resource)
bool
WriteToJson ()
Task`1
Writes resource to a JSON file, using the ResourceGenerator to create the resource.

Inheritance

ResourceCompiler
SoundResourceCompiler
TextureResourceCompiler
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