s&
newspaper
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
rocket
Discover Games
business_center
Workshop
sports_esports
Games
landscape
Maps
chair
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
docs
Docs
docs
Documentation
dashboard
Api Reference
school
Tutorials
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Classes
WorkshopPublishOptions
chevron_left
Classes
struct
WorkshopPublishOptions
search
Constructors
functions
WorkshopPublishOptions
Properties
data_object
CanSelectVisibility
data_object
Categories
data_object
Description
data_object
KeyValues
data_object
Metadata
data_object
OnComplete
data_object
PublishedFileId
data_object
StorageEntry
data_object
Tags
data_object
Thumbnail
data_object
Title
data_object
Visibility
Methods
functions
AddCategory
WorkshopPublishOptions
Passed to IModalSystem.WorkshopPublish
struct
Sandbox.Modals
.
sealed
Sandbox.Engine
build
Constructors
1
WorkshopPublishOptions
(
)
data_object
Properties
12
CanSelectVisibility
bool
Can the client select the visibility for this item
Categories
Dictionary`2
Defined categories to show in the workshop publish modal
Description
string
The description of this item. The user will be able to change it.
KeyValues
Dictionary`2
Keyvalues to store on the item. You can search and filter by these later.
Metadata
string
You can store metadata on the item, which is just a string. This can be read when querying items before downloading them - so it can be useful for storing extra info you want to store.
OnComplete
Action`1
Called when done. The ulong is the published item id. You can access it via url https://steamcommunity.com/sharedfiles/filedetails/?id=######
PublishedFileId
UInt64
If set, update this existing workshop item instead of creating a new one.
StorageEntry
Entry
The filesystem containing the files to publish
Tags
HashSet`1
Tags to set on the item. You can search and filter by these later.
Thumbnail
Bitmap
512x512 thumbnail image, no transparency
Title
string
The default title of this item. The user will be able to change it.
Visibility
Visibility
The visibility of the item
functions
Methods
1
AddCategory
(
name
)
Adds a new category associated with the specified enum type to the collection. The user will be prompted to select one of the enum values when publishing. This will be set on the file as keyvalues[name] = enum.ToString()
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.