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
WorkshopDownload
chevron_left Classes
struct
WorkshopDownload

Constructors

functionsWorkshopDownload

Properties

data_objectDownloadeddata_objectErrordata_objectErrorHelpdata_objectFractiondata_objectIddata_objectThumbdata_objectTitledata_objectTotal

Methods

functionsDeconstruct
WorkshopDownload
A workshop item coming down, or one that's ended - for the menu to show. One that ended failed if there's an Sandbox.WorkshopDownload.Error, saying what went wrong, with Sandbox.WorkshopDownload.ErrorHelp what to do about it; otherwise it finished.
struct Sandbox .
sealedSandbox.Engine

build Constructors 1

WorkshopDownload (Id, Title, Thumb, Downloaded, Total, Error, ErrorHelp)
A workshop item coming down, or one that's ended - for the menu to show. One that ended failed if there's an Sandbox.WorkshopDownload.Error, saying what went wrong, with Sandbox.WorkshopDownload.ErrorHelp what to do about it; otherwise it finished.

data_object Properties 8

Downloaded
long
How much of it's come down, in bytes
Error
string
What went wrong, if it failed
ErrorHelp
string
What to do about it
Fraction
float
How far through it is, 0 to 1
Id
UInt64
The item's workshop id
Thumb
string
Its preview image
Title
string
What it's called
Total
long
How much there is to come down, in bytes

functions Methods 1

Deconstruct (Id, Title, Thumb, Downloaded, Total, Error, ErrorHelp)
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