Steam
Classes | Public Member Functions | Properties | List of all members
LapinerTools.Steam.Data.WorkshopItemUpdate Class Reference

The WorkshopItemUpdate class stores all data required to upload a new Steam Workshop item or to update an existing item. You can get the native Steam data (e.g. PublishedFileId) from the WorkshopItem.SteamNative property. Most properties are self-explanatory and not documented in more detail. More...

Classes

class  SteamNativeData
 The WorkshopItem.SteamNativeData class contains Steam native data such as PublishedFileId, UGCUpdateHandle or ItemUpdateStatus. You can use this data to make own calls to the Steamworks.NET API. More...
 

Public Member Functions

 WorkshopItemUpdate ()
 
 WorkshopItemUpdate (WorkshopItem p_existingItem)
 
 WorkshopItemUpdate (PublishedFileId_t p_existingPublishedFileId)
 

Properties

string Name [get, set]
 
string Description [get, set]
 
string IconPath [get, set]
 The image file path, which will be used as item icon in the Steam Workshop web page and the SteamWorkshopUIBrowse. Can be null or empty. More...
 
string ContentPath [get, set]
 Everything inside this folder will be uploaded to Steam Workshop. Can be null or empty if only the name, description and icon should be updated. More...
 
string ChangeNote [get, set]
 Optional change note, which will be visible in the Steam Workshop web page. More...
 
SteamNativeData SteamNative [get, set]
 Contains Steam native data such as PublishedFileId, UGCUpdateHandle or ItemUpdateStatus. You can use this data to make own calls to the Steamworks.NET API. More...
 

Detailed Description

The WorkshopItemUpdate class stores all data required to upload a new Steam Workshop item or to update an existing item. You can get the native Steam data (e.g. PublishedFileId) from the WorkshopItem.SteamNative property. Most properties are self-explanatory and not documented in more detail.

Constructor & Destructor Documentation

◆ WorkshopItemUpdate() [1/3]

LapinerTools.Steam.Data.WorkshopItemUpdate.WorkshopItemUpdate ( )

◆ WorkshopItemUpdate() [2/3]

LapinerTools.Steam.Data.WorkshopItemUpdate.WorkshopItemUpdate ( WorkshopItem  p_existingItem)

◆ WorkshopItemUpdate() [3/3]

LapinerTools.Steam.Data.WorkshopItemUpdate.WorkshopItemUpdate ( PublishedFileId_t  p_existingPublishedFileId)

Property Documentation

◆ ChangeNote

string LapinerTools.Steam.Data.WorkshopItemUpdate.ChangeNote
getset

Optional change note, which will be visible in the Steam Workshop web page.

◆ ContentPath

string LapinerTools.Steam.Data.WorkshopItemUpdate.ContentPath
getset

Everything inside this folder will be uploaded to Steam Workshop. Can be null or empty if only the name, description and icon should be updated.

◆ Description

string LapinerTools.Steam.Data.WorkshopItemUpdate.Description
getset

◆ IconPath

string LapinerTools.Steam.Data.WorkshopItemUpdate.IconPath
getset

The image file path, which will be used as item icon in the Steam Workshop web page and the SteamWorkshopUIBrowse. Can be null or empty.

◆ Name

string LapinerTools.Steam.Data.WorkshopItemUpdate.Name
getset

◆ SteamNative

SteamNativeData LapinerTools.Steam.Data.WorkshopItemUpdate.SteamNative
getset

Contains Steam native data such as PublishedFileId, UGCUpdateHandle or ItemUpdateStatus. You can use this data to make own calls to the Steamworks.NET API.


The documentation for this class was generated from the following file: