C# Class Steamworks.SteamGameServerUGC

Show file Open project: rlabrecque/Steamworks.NET

Public Methods

Method Description
AddExcludedTag ( UGCQueryHandle_t handle, string pTagName ) : bool
AddItemKeyValueTag ( UGCUpdateHandle_t handle, string pchKey, string pchValue ) : bool

add new key-value tags for the item. Note that there can be multiple values for a tag.
AddItemPreviewFile ( UGCUpdateHandle_t handle, string pszPreviewFile, EItemPreviewType type ) : bool

add preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size
AddItemPreviewVideo ( UGCUpdateHandle_t handle, string pszVideoID ) : bool

add preview video for this item
AddItemToFavorites ( AppId_t nAppId, PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
AddRequiredKeyValueTag ( UGCQueryHandle_t handle, string pKey, string pValue ) : bool
AddRequiredTag ( UGCQueryHandle_t handle, string pTagName ) : bool

Options to set for querying UGC
BInitWorkshopForGameServer ( DepotId_t unWorkshopDepotID, string pszFolder ) : bool

game servers can set a specific workshop folder before issuing any UGC commands.

This is helpful if you want to support multiple game servers running out of the same install folder
CreateItem ( AppId_t nConsumerAppId, EWorkshopFileType eFileType ) : SteamAPICall_t

Steam Workshop Creator API

create new item for this app with no content attached yet
CreateQueryAllUGCRequest ( EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint unPage ) : UGCQueryHandle_t

Query for all matching UGC. Creator app id or consumer app id must be valid and be set to the current running app. unPage should start at 1.
CreateQueryUGCDetailsRequest ( PublishedFileId_t pvecPublishedFileID, uint unNumPublishedFileIDs ) : UGCQueryHandle_t

Query for the details of the given published file ids (the RequestUGCDetails call is deprecated and replaced with this)
CreateQueryUserUGCRequest ( AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint unPage ) : UGCQueryHandle_t

Query UGC associated with a user. Creator app id or consumer app id must be valid and be set to the current running app. unPage should start at 1.
DownloadItem ( PublishedFileId_t nPublishedFileID, bool bHighPriority ) : bool

download new or update already installed item. If function returns true, wait for DownloadItemResult_t. If the item is already installed,

then files on disk should not be used until callback received. If item is not subscribed to, it will be cached for some time.

If bHighPriority is set, any other item download will be suspended and this item downloaded ASAP.
GetItemDownloadInfo ( PublishedFileId_t nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool

get info about pending update for items that have k_EItemStateNeedsUpdate set. punBytesTotal will be valid after download started once
GetItemInstallInfo ( PublishedFileId_t nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint cchFolderSize, uint &punTimeStamp ) : bool

get info about currently installed content on disc for items that have k_EItemStateInstalled set

if k_EItemStateLegacyItem is set, pchFolder contains the path to the legacy file itself (not a folder)
GetItemState ( PublishedFileId_t nPublishedFileID ) : uint

get EItemState flags about item on this client
GetItemUpdateProgress ( UGCUpdateHandle_t handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : EItemUpdateStatus
GetNumSubscribedItems ( ) : uint

number of subscribed items
GetQueryUGCAdditionalPreview ( UGCQueryHandle_t handle, uint index, uint previewIndex, string &pchURLOrVideoID, uint cchURLSize, string &pchOriginalFileName, uint cchOriginalFileNameSize, EItemPreviewType &pPreviewType ) : bool
GetQueryUGCChildren ( UGCQueryHandle_t handle, uint index, PublishedFileId_t pvecPublishedFileID, uint cMaxEntries ) : bool
GetQueryUGCKeyValueTag ( UGCQueryHandle_t handle, uint index, uint keyValueTagIndex, string &pchKey, uint cchKeySize, string &pchValue, uint cchValueSize ) : bool
GetQueryUGCMetadata ( UGCQueryHandle_t handle, uint index, string &pchMetadata, uint cchMetadatasize ) : bool
GetQueryUGCNumAdditionalPreviews ( UGCQueryHandle_t handle, uint index ) : uint
GetQueryUGCNumKeyValueTags ( UGCQueryHandle_t handle, uint index ) : uint
GetQueryUGCPreviewURL ( UGCQueryHandle_t handle, uint index, string &pchURL, uint cchURLSize ) : bool
GetQueryUGCResult ( UGCQueryHandle_t handle, uint index, SteamUGCDetails_t &pDetails ) : bool

Retrieve an individual result after receiving the callback for querying UGC
GetQueryUGCStatistic ( UGCQueryHandle_t handle, uint index, EItemStatistic eStatType, ulong &pStatValue ) : bool
GetSubscribedItems ( PublishedFileId_t pvecPublishedFileID, uint cMaxEntries ) : uint

all subscribed item PublishFileIDs
GetUserItemVote ( PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
ReleaseQueryUGCRequest ( UGCQueryHandle_t handle ) : bool

Release the request to free up memory, after retrieving results
RemoveItemFromFavorites ( AppId_t nAppId, PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
RemoveItemKeyValueTags ( UGCUpdateHandle_t handle, string pchKey ) : bool

remove any existing key-value tags with the specified key
RemoveItemPreview ( UGCUpdateHandle_t handle, uint index ) : bool

remove a preview by index starting at 0 (previews are sorted)
RequestUGCDetails ( PublishedFileId_t nPublishedFileID, uint unMaxAgeSeconds ) : SteamAPICall_t

DEPRECATED - Use CreateQueryUGCDetailsRequest call above instead!
SendQueryUGCRequest ( UGCQueryHandle_t handle ) : SteamAPICall_t

Send the query to Steam
SetAllowCachedResponse ( UGCQueryHandle_t handle, uint unMaxAgeSeconds ) : bool
SetCloudFileNameFilter ( UGCQueryHandle_t handle, string pMatchCloudFileName ) : bool

Options only for querying user UGC
SetItemContent ( UGCUpdateHandle_t handle, string pszContentFolder ) : bool

update item content from this local folder
SetItemDescription ( UGCUpdateHandle_t handle, string pchDescription ) : bool

change the description of an UGC item
SetItemMetadata ( UGCUpdateHandle_t handle, string pchMetaData ) : bool

change the metadata of an UGC item (max = k_cchDeveloperMetadataMax)
SetItemPreview ( UGCUpdateHandle_t handle, string pszPreviewFile ) : bool

change preview image file for this item. pszPreviewFile points to local image file, which must be under 1MB in size
SetItemTags ( UGCUpdateHandle_t updateHandle, System pTags ) : bool

change the tags of an UGC item
SetItemTitle ( UGCUpdateHandle_t handle, string pchTitle ) : bool

change the title of an UGC item
SetItemUpdateLanguage ( UGCUpdateHandle_t handle, string pchLanguage ) : bool

specify the language of the title or description that will be set
SetItemVisibility ( UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility ) : bool

change the visibility of an UGC item
SetLanguage ( UGCQueryHandle_t handle, string pchLanguage ) : bool
SetMatchAnyTag ( UGCQueryHandle_t handle, bool bMatchAnyTag ) : bool

Options only for querying all UGC
SetRankedByTrendDays ( UGCQueryHandle_t handle, uint unDays ) : bool
SetReturnAdditionalPreviews ( UGCQueryHandle_t handle, bool bReturnAdditionalPreviews ) : bool
SetReturnChildren ( UGCQueryHandle_t handle, bool bReturnChildren ) : bool
SetReturnKeyValueTags ( UGCQueryHandle_t handle, bool bReturnKeyValueTags ) : bool
SetReturnLongDescription ( UGCQueryHandle_t handle, bool bReturnLongDescription ) : bool
SetReturnMetadata ( UGCQueryHandle_t handle, bool bReturnMetadata ) : bool
SetReturnOnlyIDs ( UGCQueryHandle_t handle, bool bReturnOnlyIDs ) : bool
SetReturnTotalOnly ( UGCQueryHandle_t handle, bool bReturnTotalOnly ) : bool
SetSearchText ( UGCQueryHandle_t handle, string pSearchText ) : bool
SetUserItemVote ( PublishedFileId_t nPublishedFileID, bool bVoteUp ) : SteamAPICall_t

Steam Workshop Consumer API
StartItemUpdate ( AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID ) : UGCUpdateHandle_t

start an UGC item update. Set changed properties before commiting update with CommitItemUpdate()
StartPlaytimeTracking ( PublishedFileId_t pvecPublishedFileID, uint unNumPublishedFileIDs ) : SteamAPICall_t

usage tracking
StopPlaytimeTracking ( PublishedFileId_t pvecPublishedFileID, uint unNumPublishedFileIDs ) : SteamAPICall_t
StopPlaytimeTrackingForAllItems ( ) : SteamAPICall_t
SubmitItemUpdate ( UGCUpdateHandle_t handle, string pchChangeNote ) : SteamAPICall_t

commit update process started with StartItemUpdate()
SubscribeItem ( PublishedFileId_t nPublishedFileID ) : SteamAPICall_t

subscribe to this item, will be installed ASAP
SuspendDownloads ( bool bSuspend ) : void

SuspendDownloads( true ) will suspend all workshop downloads until SuspendDownloads( false ) is called or the game ends
UnsubscribeItem ( PublishedFileId_t nPublishedFileID ) : SteamAPICall_t

unsubscribe from this item, will be uninstalled after game quits
UpdateItemPreviewFile ( UGCUpdateHandle_t handle, uint index, string pszPreviewFile ) : bool

updates an existing preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size
UpdateItemPreviewVideo ( UGCUpdateHandle_t handle, uint index, string pszVideoID ) : bool

updates an existing preview video for this item

Method Details

AddExcludedTag() public static method

public static AddExcludedTag ( UGCQueryHandle_t handle, string pTagName ) : bool
handle UGCQueryHandle_t
pTagName string
return bool

AddItemKeyValueTag() public static method

add new key-value tags for the item. Note that there can be multiple values for a tag.

public static AddItemKeyValueTag ( UGCUpdateHandle_t handle, string pchKey, string pchValue ) : bool
handle UGCUpdateHandle_t
pchKey string
pchValue string
return bool

AddItemPreviewFile() public static method

add preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size

public static AddItemPreviewFile ( UGCUpdateHandle_t handle, string pszPreviewFile, EItemPreviewType type ) : bool
handle UGCUpdateHandle_t
pszPreviewFile string
type EItemPreviewType
return bool

AddItemPreviewVideo() public static method

add preview video for this item

public static AddItemPreviewVideo ( UGCUpdateHandle_t handle, string pszVideoID ) : bool
handle UGCUpdateHandle_t
pszVideoID string
return bool

AddItemToFavorites() public static method

public static AddItemToFavorites ( AppId_t nAppId, PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
nAppId AppId_t
nPublishedFileID PublishedFileId_t
return SteamAPICall_t

AddRequiredKeyValueTag() public static method

public static AddRequiredKeyValueTag ( UGCQueryHandle_t handle, string pKey, string pValue ) : bool
handle UGCQueryHandle_t
pKey string
pValue string
return bool

AddRequiredTag() public static method

Options to set for querying UGC

public static AddRequiredTag ( UGCQueryHandle_t handle, string pTagName ) : bool
handle UGCQueryHandle_t
pTagName string
return bool

BInitWorkshopForGameServer() public static method

game servers can set a specific workshop folder before issuing any UGC commands.

This is helpful if you want to support multiple game servers running out of the same install folder

public static BInitWorkshopForGameServer ( DepotId_t unWorkshopDepotID, string pszFolder ) : bool
unWorkshopDepotID DepotId_t
pszFolder string
return bool

CreateItem() public static method

Steam Workshop Creator API

create new item for this app with no content attached yet

public static CreateItem ( AppId_t nConsumerAppId, EWorkshopFileType eFileType ) : SteamAPICall_t
nConsumerAppId AppId_t
eFileType EWorkshopFileType
return SteamAPICall_t

CreateQueryAllUGCRequest() public static method

Query for all matching UGC. Creator app id or consumer app id must be valid and be set to the current running app. unPage should start at 1.

public static CreateQueryAllUGCRequest ( EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint unPage ) : UGCQueryHandle_t
eQueryType EUGCQuery
eMatchingeMatchingUGCTypeFileType EUGCMatchingUGCType
nCreatorAppID AppId_t
nConsumerAppID AppId_t
unPage uint
return UGCQueryHandle_t

CreateQueryUGCDetailsRequest() public static method

Query for the details of the given published file ids (the RequestUGCDetails call is deprecated and replaced with this)

public static CreateQueryUGCDetailsRequest ( PublishedFileId_t pvecPublishedFileID, uint unNumPublishedFileIDs ) : UGCQueryHandle_t
pvecPublishedFileID PublishedFileId_t
unNumPublishedFileIDs uint
return UGCQueryHandle_t

CreateQueryUserUGCRequest() public static method

Query UGC associated with a user. Creator app id or consumer app id must be valid and be set to the current running app. unPage should start at 1.

public static CreateQueryUserUGCRequest ( AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint unPage ) : UGCQueryHandle_t
unAccountID AccountID_t
eListType EUserUGCList
eMatchingUGCType EUGCMatchingUGCType
eSortOrder EUserUGCListSortOrder
nCreatorAppID AppId_t
nConsumerAppID AppId_t
unPage uint
return UGCQueryHandle_t

DownloadItem() public static method

download new or update already installed item. If function returns true, wait for DownloadItemResult_t. If the item is already installed,

then files on disk should not be used until callback received. If item is not subscribed to, it will be cached for some time.

If bHighPriority is set, any other item download will be suspended and this item downloaded ASAP.

public static DownloadItem ( PublishedFileId_t nPublishedFileID, bool bHighPriority ) : bool
nPublishedFileID PublishedFileId_t
bHighPriority bool
return bool

GetItemDownloadInfo() public static method

get info about pending update for items that have k_EItemStateNeedsUpdate set. punBytesTotal will be valid after download started once

public static GetItemDownloadInfo ( PublishedFileId_t nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool
nPublishedFileID PublishedFileId_t
punBytesDownloaded ulong
punBytesTotal ulong
return bool

GetItemInstallInfo() public static method

get info about currently installed content on disc for items that have k_EItemStateInstalled set

if k_EItemStateLegacyItem is set, pchFolder contains the path to the legacy file itself (not a folder)

public static GetItemInstallInfo ( PublishedFileId_t nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint cchFolderSize, uint &punTimeStamp ) : bool
nPublishedFileID PublishedFileId_t
punSizeOnDisk ulong
pchFolder string
cchFolderSize uint
punTimeStamp uint
return bool

GetItemState() public static method

get EItemState flags about item on this client

public static GetItemState ( PublishedFileId_t nPublishedFileID ) : uint
nPublishedFileID PublishedFileId_t
return uint

GetItemUpdateProgress() public static method

public static GetItemUpdateProgress ( UGCUpdateHandle_t handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : EItemUpdateStatus
handle UGCUpdateHandle_t
punBytesProcessed ulong
punBytesTotal ulong
return EItemUpdateStatus

GetNumSubscribedItems() public static method

number of subscribed items

public static GetNumSubscribedItems ( ) : uint
return uint

GetQueryUGCAdditionalPreview() public static method

public static GetQueryUGCAdditionalPreview ( UGCQueryHandle_t handle, uint index, uint previewIndex, string &pchURLOrVideoID, uint cchURLSize, string &pchOriginalFileName, uint cchOriginalFileNameSize, EItemPreviewType &pPreviewType ) : bool
handle UGCQueryHandle_t
index uint
previewIndex uint
pchURLOrVideoID string
cchURLSize uint
pchOriginalFileName string
cchOriginalFileNameSize uint
pPreviewType EItemPreviewType
return bool

GetQueryUGCChildren() public static method

public static GetQueryUGCChildren ( UGCQueryHandle_t handle, uint index, PublishedFileId_t pvecPublishedFileID, uint cMaxEntries ) : bool
handle UGCQueryHandle_t
index uint
pvecPublishedFileID PublishedFileId_t
cMaxEntries uint
return bool

GetQueryUGCKeyValueTag() public static method

public static GetQueryUGCKeyValueTag ( UGCQueryHandle_t handle, uint index, uint keyValueTagIndex, string &pchKey, uint cchKeySize, string &pchValue, uint cchValueSize ) : bool
handle UGCQueryHandle_t
index uint
keyValueTagIndex uint
pchKey string
cchKeySize uint
pchValue string
cchValueSize uint
return bool

GetQueryUGCMetadata() public static method

public static GetQueryUGCMetadata ( UGCQueryHandle_t handle, uint index, string &pchMetadata, uint cchMetadatasize ) : bool
handle UGCQueryHandle_t
index uint
pchMetadata string
cchMetadatasize uint
return bool

GetQueryUGCNumAdditionalPreviews() public static method

public static GetQueryUGCNumAdditionalPreviews ( UGCQueryHandle_t handle, uint index ) : uint
handle UGCQueryHandle_t
index uint
return uint

GetQueryUGCNumKeyValueTags() public static method

public static GetQueryUGCNumKeyValueTags ( UGCQueryHandle_t handle, uint index ) : uint
handle UGCQueryHandle_t
index uint
return uint

GetQueryUGCPreviewURL() public static method

public static GetQueryUGCPreviewURL ( UGCQueryHandle_t handle, uint index, string &pchURL, uint cchURLSize ) : bool
handle UGCQueryHandle_t
index uint
pchURL string
cchURLSize uint
return bool

GetQueryUGCResult() public static method

Retrieve an individual result after receiving the callback for querying UGC

public static GetQueryUGCResult ( UGCQueryHandle_t handle, uint index, SteamUGCDetails_t &pDetails ) : bool
handle UGCQueryHandle_t
index uint
pDetails SteamUGCDetails_t
return bool

GetQueryUGCStatistic() public static method

public static GetQueryUGCStatistic ( UGCQueryHandle_t handle, uint index, EItemStatistic eStatType, ulong &pStatValue ) : bool
handle UGCQueryHandle_t
index uint
eStatType EItemStatistic
pStatValue ulong
return bool

GetSubscribedItems() public static method

all subscribed item PublishFileIDs

public static GetSubscribedItems ( PublishedFileId_t pvecPublishedFileID, uint cMaxEntries ) : uint
pvecPublishedFileID PublishedFileId_t
cMaxEntries uint
return uint

GetUserItemVote() public static method

public static GetUserItemVote ( PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
nPublishedFileID PublishedFileId_t
return SteamAPICall_t

ReleaseQueryUGCRequest() public static method

Release the request to free up memory, after retrieving results

public static ReleaseQueryUGCRequest ( UGCQueryHandle_t handle ) : bool
handle UGCQueryHandle_t
return bool

RemoveItemFromFavorites() public static method

public static RemoveItemFromFavorites ( AppId_t nAppId, PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
nAppId AppId_t
nPublishedFileID PublishedFileId_t
return SteamAPICall_t

RemoveItemKeyValueTags() public static method

remove any existing key-value tags with the specified key

public static RemoveItemKeyValueTags ( UGCUpdateHandle_t handle, string pchKey ) : bool
handle UGCUpdateHandle_t
pchKey string
return bool

RemoveItemPreview() public static method

remove a preview by index starting at 0 (previews are sorted)

public static RemoveItemPreview ( UGCUpdateHandle_t handle, uint index ) : bool
handle UGCUpdateHandle_t
index uint
return bool

RequestUGCDetails() public static method

DEPRECATED - Use CreateQueryUGCDetailsRequest call above instead!

public static RequestUGCDetails ( PublishedFileId_t nPublishedFileID, uint unMaxAgeSeconds ) : SteamAPICall_t
nPublishedFileID PublishedFileId_t
unMaxAgeSeconds uint
return SteamAPICall_t

SendQueryUGCRequest() public static method

Send the query to Steam

public static SendQueryUGCRequest ( UGCQueryHandle_t handle ) : SteamAPICall_t
handle UGCQueryHandle_t
return SteamAPICall_t

SetAllowCachedResponse() public static method

public static SetAllowCachedResponse ( UGCQueryHandle_t handle, uint unMaxAgeSeconds ) : bool
handle UGCQueryHandle_t
unMaxAgeSeconds uint
return bool

SetCloudFileNameFilter() public static method

Options only for querying user UGC

public static SetCloudFileNameFilter ( UGCQueryHandle_t handle, string pMatchCloudFileName ) : bool
handle UGCQueryHandle_t
pMatchCloudFileName string
return bool

SetItemContent() public static method

update item content from this local folder

public static SetItemContent ( UGCUpdateHandle_t handle, string pszContentFolder ) : bool
handle UGCUpdateHandle_t
pszContentFolder string
return bool

SetItemDescription() public static method

change the description of an UGC item

public static SetItemDescription ( UGCUpdateHandle_t handle, string pchDescription ) : bool
handle UGCUpdateHandle_t
pchDescription string
return bool

SetItemMetadata() public static method

change the metadata of an UGC item (max = k_cchDeveloperMetadataMax)

public static SetItemMetadata ( UGCUpdateHandle_t handle, string pchMetaData ) : bool
handle UGCUpdateHandle_t
pchMetaData string
return bool

SetItemPreview() public static method

change preview image file for this item. pszPreviewFile points to local image file, which must be under 1MB in size

public static SetItemPreview ( UGCUpdateHandle_t handle, string pszPreviewFile ) : bool
handle UGCUpdateHandle_t
pszPreviewFile string
return bool

SetItemTags() public static method

change the tags of an UGC item

public static SetItemTags ( UGCUpdateHandle_t updateHandle, System pTags ) : bool
updateHandle UGCUpdateHandle_t
pTags System
return bool

SetItemTitle() public static method

change the title of an UGC item

public static SetItemTitle ( UGCUpdateHandle_t handle, string pchTitle ) : bool
handle UGCUpdateHandle_t
pchTitle string
return bool

SetItemUpdateLanguage() public static method

specify the language of the title or description that will be set

public static SetItemUpdateLanguage ( UGCUpdateHandle_t handle, string pchLanguage ) : bool
handle UGCUpdateHandle_t
pchLanguage string
return bool

SetItemVisibility() public static method

change the visibility of an UGC item

public static SetItemVisibility ( UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility ) : bool
handle UGCUpdateHandle_t
eVisibility ERemoteStoragePublishedFileVisibility
return bool

SetLanguage() public static method

public static SetLanguage ( UGCQueryHandle_t handle, string pchLanguage ) : bool
handle UGCQueryHandle_t
pchLanguage string
return bool

SetMatchAnyTag() public static method

Options only for querying all UGC

public static SetMatchAnyTag ( UGCQueryHandle_t handle, bool bMatchAnyTag ) : bool
handle UGCQueryHandle_t
bMatchAnyTag bool
return bool

SetRankedByTrendDays() public static method

public static SetRankedByTrendDays ( UGCQueryHandle_t handle, uint unDays ) : bool
handle UGCQueryHandle_t
unDays uint
return bool

SetReturnAdditionalPreviews() public static method

public static SetReturnAdditionalPreviews ( UGCQueryHandle_t handle, bool bReturnAdditionalPreviews ) : bool
handle UGCQueryHandle_t
bReturnAdditionalPreviews bool
return bool

SetReturnChildren() public static method

public static SetReturnChildren ( UGCQueryHandle_t handle, bool bReturnChildren ) : bool
handle UGCQueryHandle_t
bReturnChildren bool
return bool

SetReturnKeyValueTags() public static method

public static SetReturnKeyValueTags ( UGCQueryHandle_t handle, bool bReturnKeyValueTags ) : bool
handle UGCQueryHandle_t
bReturnKeyValueTags bool
return bool

SetReturnLongDescription() public static method

public static SetReturnLongDescription ( UGCQueryHandle_t handle, bool bReturnLongDescription ) : bool
handle UGCQueryHandle_t
bReturnLongDescription bool
return bool

SetReturnMetadata() public static method

public static SetReturnMetadata ( UGCQueryHandle_t handle, bool bReturnMetadata ) : bool
handle UGCQueryHandle_t
bReturnMetadata bool
return bool

SetReturnOnlyIDs() public static method

public static SetReturnOnlyIDs ( UGCQueryHandle_t handle, bool bReturnOnlyIDs ) : bool
handle UGCQueryHandle_t
bReturnOnlyIDs bool
return bool

SetReturnTotalOnly() public static method

public static SetReturnTotalOnly ( UGCQueryHandle_t handle, bool bReturnTotalOnly ) : bool
handle UGCQueryHandle_t
bReturnTotalOnly bool
return bool

SetSearchText() public static method

public static SetSearchText ( UGCQueryHandle_t handle, string pSearchText ) : bool
handle UGCQueryHandle_t
pSearchText string
return bool

SetUserItemVote() public static method

Steam Workshop Consumer API

public static SetUserItemVote ( PublishedFileId_t nPublishedFileID, bool bVoteUp ) : SteamAPICall_t
nPublishedFileID PublishedFileId_t
bVoteUp bool
return SteamAPICall_t

StartItemUpdate() public static method

start an UGC item update. Set changed properties before commiting update with CommitItemUpdate()

public static StartItemUpdate ( AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID ) : UGCUpdateHandle_t
nConsumerAppId AppId_t
nPublishedFileID PublishedFileId_t
return UGCUpdateHandle_t

StartPlaytimeTracking() public static method

usage tracking

public static StartPlaytimeTracking ( PublishedFileId_t pvecPublishedFileID, uint unNumPublishedFileIDs ) : SteamAPICall_t
pvecPublishedFileID PublishedFileId_t
unNumPublishedFileIDs uint
return SteamAPICall_t

StopPlaytimeTracking() public static method

public static StopPlaytimeTracking ( PublishedFileId_t pvecPublishedFileID, uint unNumPublishedFileIDs ) : SteamAPICall_t
pvecPublishedFileID PublishedFileId_t
unNumPublishedFileIDs uint
return SteamAPICall_t

StopPlaytimeTrackingForAllItems() public static method

public static StopPlaytimeTrackingForAllItems ( ) : SteamAPICall_t
return SteamAPICall_t

SubmitItemUpdate() public static method

commit update process started with StartItemUpdate()

public static SubmitItemUpdate ( UGCUpdateHandle_t handle, string pchChangeNote ) : SteamAPICall_t
handle UGCUpdateHandle_t
pchChangeNote string
return SteamAPICall_t

SubscribeItem() public static method

subscribe to this item, will be installed ASAP

public static SubscribeItem ( PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
nPublishedFileID PublishedFileId_t
return SteamAPICall_t

SuspendDownloads() public static method

SuspendDownloads( true ) will suspend all workshop downloads until SuspendDownloads( false ) is called or the game ends

public static SuspendDownloads ( bool bSuspend ) : void
bSuspend bool
return void

UnsubscribeItem() public static method

unsubscribe from this item, will be uninstalled after game quits

public static UnsubscribeItem ( PublishedFileId_t nPublishedFileID ) : SteamAPICall_t
nPublishedFileID PublishedFileId_t
return SteamAPICall_t

UpdateItemPreviewFile() public static method

updates an existing preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size

public static UpdateItemPreviewFile ( UGCUpdateHandle_t handle, uint index, string pszPreviewFile ) : bool
handle UGCUpdateHandle_t
index uint
pszPreviewFile string
return bool

UpdateItemPreviewVideo() public static method

updates an existing preview video for this item

public static UpdateItemPreviewVideo ( UGCUpdateHandle_t handle, uint index, string pszVideoID ) : bool
handle UGCUpdateHandle_t
index uint
pszVideoID string
return bool