SteamGameServerUGC
Class SteamGameServerUGC
Namespace: SwiftlyS2.Shared.SteamAPI
Assembly: SwiftlyS2.CS2.dll
public static class SteamGameServerUGCInheritance
Inherited Members
- object.Equals(object?)
- object.Equals(object?, object?)
- object.GetHashCode()
- object.GetType()
- object.MemberwiseClone()
- object.ReferenceEquals(object?, object?)
- object.ToString()
Methods
AddAppDependency(PublishedFileId_t, AppId_t)
add/remove app dependence/requirements (usually DLC)
public static SteamAPICall_t AddAppDependency(PublishedFileId_t nPublishedFileID, AppId_t nAppID)Parameters
- nPublishedFileID PublishedFileId_t
- nAppID AppId_t
Returns
AddContentDescriptor(UGCUpdateHandle_t, EUGCContentDescriptorID)
public static bool AddContentDescriptor(UGCUpdateHandle_t handle, EUGCContentDescriptorID descid)Parameters
- handle UGCUpdateHandle_t
- descid EUGCContentDescriptorID
Returns
AddDependency(PublishedFileId_t, PublishedFileId_t)
parent-child relationship or dependency management
public static SteamAPICall_t AddDependency(PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID)Parameters
- nParentPublishedFileID PublishedFileId_t
- nChildPublishedFileID PublishedFileId_t
Returns
AddExcludedTag(UGCQueryHandle_t, string)
public static bool AddExcludedTag(UGCQueryHandle_t handle, string pTagName)Parameters
- handle UGCQueryHandle_t
- pTagName string
Returns
AddItemKeyValueTag(UGCUpdateHandle_t, string, string)
add new key-value tags for the item. Note that there can be multiple values for a tag.
public static bool AddItemKeyValueTag(UGCUpdateHandle_t handle, string pchKey, string pchValue)Parameters
- handle UGCUpdateHandle_t
- pchKey string
- pchValue string
Returns
AddItemPreviewFile(UGCUpdateHandle_t, string, EItemPreviewType)
add preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size
public static bool AddItemPreviewFile(UGCUpdateHandle_t handle, string pszPreviewFile, EItemPreviewType type)Parameters
- handle UGCUpdateHandle_t
- pszPreviewFile string
- type EItemPreviewType
Returns
AddItemPreviewVideo(UGCUpdateHandle_t, string)
add preview video for this item
public static bool AddItemPreviewVideo(UGCUpdateHandle_t handle, string pszVideoID)Parameters
- handle UGCUpdateHandle_t
- pszVideoID string
Returns
AddItemToFavorites(AppId_t, PublishedFileId_t)
public static SteamAPICall_t AddItemToFavorites(AppId_t nAppId, PublishedFileId_t nPublishedFileID)Parameters
- nAppId AppId_t
- nPublishedFileID PublishedFileId_t
Returns
AddRequiredKeyValueTag(UGCQueryHandle_t, string, string)
public static bool AddRequiredKeyValueTag(UGCQueryHandle_t handle, string pKey, string pValue)Parameters
- handle UGCQueryHandle_t
- pKey string
- pValue string
Returns
AddRequiredTag(UGCQueryHandle_t, string)
Options to set for querying UGC
public static bool AddRequiredTag(UGCQueryHandle_t handle, string pTagName)Parameters
- handle UGCQueryHandle_t
- pTagName string
Returns
AddRequiredTagGroup(UGCQueryHandle_t, IList<string>)
match any of the tags in this group
public static bool AddRequiredTagGroup(UGCQueryHandle_t handle, IList<string> pTagGroups)Parameters
- handle UGCQueryHandle_t
- pTagGroups IList<string>
Returns
BInitWorkshopForGameServer(DepotId_t, string)
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 bool BInitWorkshopForGameServer(DepotId_t unWorkshopDepotID, string pszFolder)Parameters
Returns
CreateItem(AppId_t, EWorkshopFileType)
Steam Workshop Creator API
create new item for this app with no content attached yet
public static SteamAPICall_t CreateItem(AppId_t nConsumerAppId, EWorkshopFileType eFileType)Parameters
- nConsumerAppId AppId_t
- eFileType EWorkshopFileType
Returns
CreateQueryAllUGCRequest(EUGCQuery, EUGCMatchingUGCType, AppId_t, AppId_t, uint)
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 UGCQueryHandle_t CreateQueryAllUGCRequest(EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint unPage)Parameters
- eQueryType EUGCQuery
- eMatchingeMatchingUGCTypeFileType EUGCMatchingUGCType
- nCreatorAppID AppId_t
- nConsumerAppID AppId_t
- unPage uint
Returns
CreateQueryAllUGCRequest(EUGCQuery, EUGCMatchingUGCType, AppId_t, AppId_t, string)
Query for all matching UGC using the new deep paging interface. Creator app id or consumer app id must be valid and be set to the current running app. pchCursor should be set to NULL or "*" to get the first result set.
public static UGCQueryHandle_t CreateQueryAllUGCRequest(EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, string pchCursor = null)Parameters
- eQueryType EUGCQuery
- eMatchingeMatchingUGCTypeFileType EUGCMatchingUGCType
- nCreatorAppID AppId_t
- nConsumerAppID AppId_t
- pchCursor string
Returns
CreateQueryUGCDetailsRequest(PublishedFileId_t[], uint)
Query for the details of the given published file ids (the RequestUGCDetails call is deprecated and replaced with this)
public static UGCQueryHandle_t CreateQueryUGCDetailsRequest(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)Parameters
- pvecPublishedFileID PublishedFileId_t[]
- unNumPublishedFileIDs uint
Returns
CreateQueryUserUGCRequest(AccountID_t, EUserUGCList, EUGCMatchingUGCType, EUserUGCListSortOrder, AppId_t, AppId_t, uint)
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 UGCQueryHandle_t CreateQueryUserUGCRequest(AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint unPage)Parameters
- unAccountID AccountID_t
- eListType EUserUGCList
- eMatchingUGCType EUGCMatchingUGCType
- eSortOrder EUserUGCListSortOrder
- nCreatorAppID AppId_t
- nConsumerAppID AppId_t
- unPage uint
Returns
DeleteItem(PublishedFileId_t)
delete the item without prompting the user
public static SteamAPICall_t DeleteItem(PublishedFileId_t nPublishedFileID)Parameters
- nPublishedFileID PublishedFileId_t
Returns
DownloadItem(PublishedFileId_t, 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.
public static bool DownloadItem(PublishedFileId_t nPublishedFileID, bool bHighPriority)Parameters
- nPublishedFileID PublishedFileId_t
- bHighPriority bool
Returns
GetAppDependencies(PublishedFileId_t)
request app dependencies. note that whatever callback you register for GetAppDependenciesResult_t may be called multiple times
until all app dependencies have been returned
public static SteamAPICall_t GetAppDependencies(PublishedFileId_t nPublishedFileID)Parameters
- nPublishedFileID PublishedFileId_t
Returns
GetItemDownloadInfo(PublishedFileId_t, out ulong, out ulong)
get info about pending update for items that have k_EItemStateNeedsUpdate set. punBytesTotal will be valid after download started once
public static bool GetItemDownloadInfo(PublishedFileId_t nPublishedFileID, out ulong punBytesDownloaded, out ulong punBytesTotal)Parameters
- nPublishedFileID PublishedFileId_t
- punBytesDownloaded ulong
- punBytesTotal ulong
Returns
GetItemInstallInfo(PublishedFileId_t, out ulong, out string, uint, out uint)
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 bool GetItemInstallInfo(PublishedFileId_t nPublishedFileID, out ulong punSizeOnDisk, out string pchFolder, uint cchFolderSize, out uint punTimeStamp)Parameters
- nPublishedFileID PublishedFileId_t
- punSizeOnDisk ulong
- pchFolder string
- cchFolderSize uint
- punTimeStamp uint
Returns
GetItemState(PublishedFileId_t)
get EItemState flags about item on this client
public static uint GetItemState(PublishedFileId_t nPublishedFileID)Parameters
- nPublishedFileID PublishedFileId_t
Returns
GetItemUpdateProgress(UGCUpdateHandle_t, out ulong, out ulong)
public static EItemUpdateStatus GetItemUpdateProgress(UGCUpdateHandle_t handle, out ulong punBytesProcessed, out ulong punBytesTotal)Parameters
- handle UGCUpdateHandle_t
- punBytesProcessed ulong
- punBytesTotal ulong
Returns
GetNumSubscribedItems(bool)
number of subscribed items
public static uint GetNumSubscribedItems(bool bIncludeLocallyDisabled = false)Parameters
- bIncludeLocallyDisabled bool
Returns
GetNumSupportedGameVersions(UGCQueryHandle_t, uint)
Some items can specify that they have a version that is valid for a range of game versions (Steam branch)
public static uint GetNumSupportedGameVersions(UGCQueryHandle_t handle, uint index)Parameters
- handle UGCQueryHandle_t
- index uint
Returns
GetQueryUGCAdditionalPreview(UGCQueryHandle_t, uint, uint, out string, uint, out string, uint, out EItemPreviewType)
public static bool GetQueryUGCAdditionalPreview(UGCQueryHandle_t handle, uint index, uint previewIndex, out string pchURLOrVideoID, uint cchURLSize, out string pchOriginalFileName, uint cchOriginalFileNameSize, out EItemPreviewType pPreviewType)Parameters
- handle UGCQueryHandle_t
- index uint
- previewIndex uint
- pchURLOrVideoID string
- cchURLSize uint
- pchOriginalFileName string
- cchOriginalFileNameSize uint
- pPreviewType EItemPreviewType
Returns
GetQueryUGCChildren(UGCQueryHandle_t, uint, PublishedFileId_t[], uint)
public static bool GetQueryUGCChildren(UGCQueryHandle_t handle, uint index, PublishedFileId_t[] pvecPublishedFileID, uint cMaxEntries)Parameters
- handle UGCQueryHandle_t
- index uint
- pvecPublishedFileID PublishedFileId_t[]
- cMaxEntries uint
Returns
GetQueryUGCContentDescriptors(UGCQueryHandle_t, uint, out EUGCContentDescriptorID, uint)
public static uint GetQueryUGCContentDescriptors(UGCQueryHandle_t handle, uint index, out EUGCContentDescriptorID pvecDescriptors, uint cMaxEntries)Parameters
- handle UGCQueryHandle_t
- index uint
- pvecDescriptors EUGCContentDescriptorID
- cMaxEntries uint
Returns
GetQueryUGCKeyValueTag(UGCQueryHandle_t, uint, uint, out string, uint, out string, uint)
public static bool GetQueryUGCKeyValueTag(UGCQueryHandle_t handle, uint index, uint keyValueTagIndex, out string pchKey, uint cchKeySize, out string pchValue, uint cchValueSize)Parameters
- handle UGCQueryHandle_t
- index uint
- keyValueTagIndex uint
- pchKey string
- cchKeySize uint
- pchValue string
- cchValueSize uint
Returns
GetQueryUGCKeyValueTag(UGCQueryHandle_t, uint, string, out string, uint)
Return the first value matching the pchKey. Note that a key may map to multiple values. Returns false if there was an error or no matching value was found.
public static bool GetQueryUGCKeyValueTag(UGCQueryHandle_t handle, uint index, string pchKey, out string pchValue, uint cchValueSize)Parameters
- handle UGCQueryHandle_t
- index uint
- pchKey string
- pchValue string
- cchValueSize uint
Returns
GetQueryUGCMetadata(UGCQueryHandle_t, uint, out string, uint)
public static bool GetQueryUGCMetadata(UGCQueryHandle_t handle, uint index, out string pchMetadata, uint cchMetadatasize)Parameters
- handle UGCQueryHandle_t
- index uint
- pchMetadata string
- cchMetadatasize uint
Returns
GetQueryUGCNumAdditionalPreviews(UGCQueryHandle_t, uint)
public static uint GetQueryUGCNumAdditionalPreviews(UGCQueryHandle_t handle, uint index)Parameters
- handle UGCQueryHandle_t
- index uint
Returns
GetQueryUGCNumKeyValueTags(UGCQueryHandle_t, uint)
public static uint GetQueryUGCNumKeyValueTags(UGCQueryHandle_t handle, uint index)Parameters
- handle UGCQueryHandle_t
- index uint
Returns
GetQueryUGCNumTags(UGCQueryHandle_t, uint)
public static uint GetQueryUGCNumTags(UGCQueryHandle_t handle, uint index)Parameters
- handle UGCQueryHandle_t
- index uint
Returns
GetQueryUGCPreviewURL(UGCQueryHandle_t, uint, out string, uint)
public static bool GetQueryUGCPreviewURL(UGCQueryHandle_t handle, uint index, out string pchURL, uint cchURLSize)Parameters
- handle UGCQueryHandle_t
- index uint
- pchURL string
- cchURLSize uint
Returns
GetQueryUGCResult(UGCQueryHandle_t, uint, out SteamUGCDetails_t)
Retrieve an individual result after receiving the callback for querying UGC
public static bool GetQueryUGCResult(UGCQueryHandle_t handle, uint index, out SteamUGCDetails_t pDetails)Parameters
- handle UGCQueryHandle_t
- index uint
- pDetails SteamUGCDetails_t
Returns
GetQueryUGCStatistic(UGCQueryHandle_t, uint, EItemStatistic, out ulong)
public static bool GetQueryUGCStatistic(UGCQueryHandle_t handle, uint index, EItemStatistic eStatType, out ulong pStatValue)Parameters
- handle UGCQueryHandle_t
- index uint
- eStatType EItemStatistic
- pStatValue ulong
Returns
GetQueryUGCTag(UGCQueryHandle_t, uint, uint, out string, uint)
public static bool GetQueryUGCTag(UGCQueryHandle_t handle, uint index, uint indexTag, out string pchValue, uint cchValueSize)Parameters
- handle UGCQueryHandle_t
- index uint
- indexTag uint
- pchValue string
- cchValueSize uint
Returns
GetQueryUGCTagDisplayName(UGCQueryHandle_t, uint, uint, out string, uint)
public static bool GetQueryUGCTagDisplayName(UGCQueryHandle_t handle, uint index, uint indexTag, out string pchValue, uint cchValueSize)Parameters
- handle UGCQueryHandle_t
- index uint
- indexTag uint
- pchValue string
- cchValueSize uint
Returns
GetSubscribedItems(PublishedFileId_t[], uint, bool)
all subscribed item PublishFileIDs
public static uint GetSubscribedItems(PublishedFileId_t[] pvecPublishedFileID, uint cMaxEntries, bool bIncludeLocallyDisabled = false)Parameters
- pvecPublishedFileID PublishedFileId_t[]
- cMaxEntries uint
- bIncludeLocallyDisabled bool
Returns
GetSupportedGameVersionData(UGCQueryHandle_t, uint, uint, out string, out string, uint)
public static bool GetSupportedGameVersionData(UGCQueryHandle_t handle, uint index, uint versionIndex, out string pchGameBranchMin, out string pchGameBranchMax, uint cchGameBranchSize)Parameters
- handle UGCQueryHandle_t
- index uint
- versionIndex uint
- pchGameBranchMin string
- pchGameBranchMax string
- cchGameBranchSize uint
Returns
GetUserContentDescriptorPreferences(out EUGCContentDescriptorID, uint)
Return the user's community content descriptor preferences
public static uint GetUserContentDescriptorPreferences(out EUGCContentDescriptorID pvecDescriptors, uint cMaxEntries)Parameters
- pvecDescriptors EUGCContentDescriptorID
- cMaxEntries uint
Returns
GetUserItemVote(PublishedFileId_t)
public static SteamAPICall_t GetUserItemVote(PublishedFileId_t nPublishedFileID)Parameters
- nPublishedFileID PublishedFileId_t
Returns
GetWorkshopEULAStatus()
Retrieve information related to the user's acceptance or not of the app's specific Workshop EULA
public static SteamAPICall_t GetWorkshopEULAStatus()Returns
ReleaseQueryUGCRequest(UGCQueryHandle_t)
Release the request to free up memory, after retrieving results
public static bool ReleaseQueryUGCRequest(UGCQueryHandle_t handle)Parameters
- handle UGCQueryHandle_t
Returns
RemoveAllItemKeyValueTags(UGCUpdateHandle_t)
remove all existing key-value tags (you can add new ones via the AddItemKeyValueTag function)
public static bool RemoveAllItemKeyValueTags(UGCUpdateHandle_t handle)Parameters
- handle UGCUpdateHandle_t
Returns
RemoveAppDependency(PublishedFileId_t, AppId_t)
public static SteamAPICall_t RemoveAppDependency(PublishedFileId_t nPublishedFileID, AppId_t nAppID)Parameters
- nPublishedFileID PublishedFileId_t
- nAppID AppId_t
Returns
RemoveContentDescriptor(UGCUpdateHandle_t, EUGCContentDescriptorID)
public static bool RemoveContentDescriptor(UGCUpdateHandle_t handle, EUGCContentDescriptorID descid)Parameters
- handle UGCUpdateHandle_t
- descid EUGCContentDescriptorID
Returns
RemoveDependency(PublishedFileId_t, PublishedFileId_t)
public static SteamAPICall_t RemoveDependency(PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID)Parameters
- nParentPublishedFileID PublishedFileId_t
- nChildPublishedFileID PublishedFileId_t
Returns
RemoveItemFromFavorites(AppId_t, PublishedFileId_t)
public static SteamAPICall_t RemoveItemFromFavorites(AppId_t nAppId, PublishedFileId_t nPublishedFileID)Parameters
- nAppId AppId_t
- nPublishedFileID PublishedFileId_t
Returns
RemoveItemKeyValueTags(UGCUpdateHandle_t, string)
remove any existing key-value tags with the specified key
public static bool RemoveItemKeyValueTags(UGCUpdateHandle_t handle, string pchKey)Parameters
- handle UGCUpdateHandle_t
- pchKey string
Returns
RemoveItemPreview(UGCUpdateHandle_t, uint)
remove a preview by index starting at 0 (previews are sorted)
public static bool RemoveItemPreview(UGCUpdateHandle_t handle, uint index)Parameters
- handle UGCUpdateHandle_t
- index uint
Returns
RequestUGCDetails(PublishedFileId_t, uint)
DEPRECATED - Use CreateQueryUGCDetailsRequest call above instead!
public static SteamAPICall_t RequestUGCDetails(PublishedFileId_t nPublishedFileID, uint unMaxAgeSeconds)Parameters
- nPublishedFileID PublishedFileId_t
- unMaxAgeSeconds uint
Returns
SendQueryUGCRequest(UGCQueryHandle_t)
Send the query to Steam
public static SteamAPICall_t SendQueryUGCRequest(UGCQueryHandle_t handle)Parameters
- handle UGCQueryHandle_t
Returns
SetAdminQuery(UGCUpdateHandle_t, bool)
admin queries return hidden items
public static bool SetAdminQuery(UGCUpdateHandle_t handle, bool bAdminQuery)Parameters
- handle UGCUpdateHandle_t
- bAdminQuery bool
Returns
SetAllowCachedResponse(UGCQueryHandle_t, uint)
public static bool SetAllowCachedResponse(UGCQueryHandle_t handle, uint unMaxAgeSeconds)Parameters
- handle UGCQueryHandle_t
- unMaxAgeSeconds uint
Returns
SetAllowLegacyUpload(UGCUpdateHandle_t, bool)
use legacy upload for a single small file. The parameter to SetItemContent() should either be a directory with one file or the full path to the file. The file must also be less than 10MB in size.
public static bool SetAllowLegacyUpload(UGCUpdateHandle_t handle, bool bAllowLegacyUpload)Parameters
- handle UGCUpdateHandle_t
- bAllowLegacyUpload bool
Returns
SetCloudFileNameFilter(UGCQueryHandle_t, string)
Options only for querying user UGC
public static bool SetCloudFileNameFilter(UGCQueryHandle_t handle, string pMatchCloudFileName)Parameters
- handle UGCQueryHandle_t
- pMatchCloudFileName string
Returns
SetItemContent(UGCUpdateHandle_t, string)
update item content from this local folder
public static bool SetItemContent(UGCUpdateHandle_t handle, string pszContentFolder)Parameters
- handle UGCUpdateHandle_t
- pszContentFolder string
Returns
SetItemDescription(UGCUpdateHandle_t, string)
change the description of an UGC item
public static bool SetItemDescription(UGCUpdateHandle_t handle, string pchDescription)Parameters
- handle UGCUpdateHandle_t
- pchDescription string
Returns
SetItemMetadata(UGCUpdateHandle_t, string)
change the metadata of an UGC item (max = k_cchDeveloperMetadataMax)
public static bool SetItemMetadata(UGCUpdateHandle_t handle, string pchMetaData)Parameters
- handle UGCUpdateHandle_t
- pchMetaData string
Returns
SetItemPreview(UGCUpdateHandle_t, string)
change preview image file for this item. pszPreviewFile points to local image file, which must be under 1MB in size
public static bool SetItemPreview(UGCUpdateHandle_t handle, string pszPreviewFile)Parameters
- handle UGCUpdateHandle_t
- pszPreviewFile string
Returns
SetItemTags(UGCUpdateHandle_t, IList<string>, bool)
change the tags of an UGC item
public static bool SetItemTags(UGCUpdateHandle_t updateHandle, IList<string> pTags, bool bAllowAdminTags = false)Parameters
- updateHandle UGCUpdateHandle_t
- pTags IList<string>
- bAllowAdminTags bool
Returns
SetItemTitle(UGCUpdateHandle_t, string)
change the title of an UGC item
public static bool SetItemTitle(UGCUpdateHandle_t handle, string pchTitle)Parameters
- handle UGCUpdateHandle_t
- pchTitle string
Returns
SetItemUpdateLanguage(UGCUpdateHandle_t, string)
specify the language of the title or description that will be set
public static bool SetItemUpdateLanguage(UGCUpdateHandle_t handle, string pchLanguage)Parameters
- handle UGCUpdateHandle_t
- pchLanguage string
Returns
SetItemVisibility(UGCUpdateHandle_t, ERemoteStoragePublishedFileVisibility)
change the visibility of an UGC item
public static bool SetItemVisibility(UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility)Parameters
- handle UGCUpdateHandle_t
- eVisibility ERemoteStoragePublishedFileVisibility
Returns
SetItemsDisabledLocally(out PublishedFileId_t, uint, bool)
Sets whether the item should be disabled locally or not. This means that it will not be returned in GetSubscribedItems() by default.
public static bool SetItemsDisabledLocally(out PublishedFileId_t pvecPublishedFileIDs, uint unNumPublishedFileIDs, bool bDisabledLocally)Parameters
- pvecPublishedFileIDs PublishedFileId_t
- unNumPublishedFileIDs uint
- bDisabledLocally bool
Returns
SetLanguage(UGCQueryHandle_t, string)
public static bool SetLanguage(UGCQueryHandle_t handle, string pchLanguage)Parameters
- handle UGCQueryHandle_t
- pchLanguage string
Returns
SetMatchAnyTag(UGCQueryHandle_t, bool)
Options only for querying all UGC
public static bool SetMatchAnyTag(UGCQueryHandle_t handle, bool bMatchAnyTag)Parameters
- handle UGCQueryHandle_t
- bMatchAnyTag bool
Returns
SetRankedByTrendDays(UGCQueryHandle_t, uint)
public static bool SetRankedByTrendDays(UGCQueryHandle_t handle, uint unDays)Parameters
- handle UGCQueryHandle_t
- unDays uint
Returns
SetRequiredGameVersions(UGCUpdateHandle_t, string, string)
an empty string for either parameter means that it will match any version on that end of the range. This will only be applied if the actual content has been changed.
public static bool SetRequiredGameVersions(UGCUpdateHandle_t handle, string pszGameBranchMin, string pszGameBranchMax)Parameters
- handle UGCUpdateHandle_t
- pszGameBranchMin string
- pszGameBranchMax string
Returns
SetReturnAdditionalPreviews(UGCQueryHandle_t, bool)
public static bool SetReturnAdditionalPreviews(UGCQueryHandle_t handle, bool bReturnAdditionalPreviews)Parameters
- handle UGCQueryHandle_t
- bReturnAdditionalPreviews bool
Returns
SetReturnChildren(UGCQueryHandle_t, bool)
public static bool SetReturnChildren(UGCQueryHandle_t handle, bool bReturnChildren)Parameters
- handle UGCQueryHandle_t
- bReturnChildren bool
Returns
SetReturnKeyValueTags(UGCQueryHandle_t, bool)
public static bool SetReturnKeyValueTags(UGCQueryHandle_t handle, bool bReturnKeyValueTags)Parameters
- handle UGCQueryHandle_t
- bReturnKeyValueTags bool
Returns
SetReturnLongDescription(UGCQueryHandle_t, bool)
public static bool SetReturnLongDescription(UGCQueryHandle_t handle, bool bReturnLongDescription)Parameters
- handle UGCQueryHandle_t
- bReturnLongDescription bool
Returns
SetReturnMetadata(UGCQueryHandle_t, bool)
public static bool SetReturnMetadata(UGCQueryHandle_t handle, bool bReturnMetadata)Parameters
- handle UGCQueryHandle_t
- bReturnMetadata bool
Returns
SetReturnOnlyIDs(UGCQueryHandle_t, bool)
public static bool SetReturnOnlyIDs(UGCQueryHandle_t handle, bool bReturnOnlyIDs)Parameters
- handle UGCQueryHandle_t
- bReturnOnlyIDs bool
Returns
SetReturnPlaytimeStats(UGCQueryHandle_t, uint)
public static bool SetReturnPlaytimeStats(UGCQueryHandle_t handle, uint unDays)Parameters
- handle UGCQueryHandle_t
- unDays uint
Returns
SetReturnTotalOnly(UGCQueryHandle_t, bool)
public static bool SetReturnTotalOnly(UGCQueryHandle_t handle, bool bReturnTotalOnly)Parameters
- handle UGCQueryHandle_t
- bReturnTotalOnly bool
Returns
SetSearchText(UGCQueryHandle_t, string)
public static bool SetSearchText(UGCQueryHandle_t handle, string pSearchText)Parameters
- handle UGCQueryHandle_t
- pSearchText string
Returns
SetSubscriptionsLoadOrder(out PublishedFileId_t, uint)
Set the local load order for these items. If there are any items not in the given list, they will sort by the time subscribed.
public static bool SetSubscriptionsLoadOrder(out PublishedFileId_t pvecPublishedFileIDs, uint unNumPublishedFileIDs)Parameters
- pvecPublishedFileIDs PublishedFileId_t
- unNumPublishedFileIDs uint
Returns
SetTimeCreatedDateRange(UGCQueryHandle_t, uint, uint)
public static bool SetTimeCreatedDateRange(UGCQueryHandle_t handle, uint rtStart, uint rtEnd)Parameters
- handle UGCQueryHandle_t
- rtStart uint
- rtEnd uint
Returns
SetTimeUpdatedDateRange(UGCQueryHandle_t, uint, uint)
public static bool SetTimeUpdatedDateRange(UGCQueryHandle_t handle, uint rtStart, uint rtEnd)Parameters
- handle UGCQueryHandle_t
- rtStart uint
- rtEnd uint
Returns
SetUserItemVote(PublishedFileId_t, bool)
Steam Workshop Consumer API
public static SteamAPICall_t SetUserItemVote(PublishedFileId_t nPublishedFileID, bool bVoteUp)Parameters
- nPublishedFileID PublishedFileId_t
- bVoteUp bool
Returns
ShowWorkshopEULA()
Show the app's latest Workshop EULA to the user in an overlay window, where they can accept it or not
public static bool ShowWorkshopEULA()Returns
StartItemUpdate(AppId_t, PublishedFileId_t)
start an UGC item update. Set changed properties before commiting update with CommitItemUpdate()
public static UGCUpdateHandle_t StartItemUpdate(AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID)Parameters
- nConsumerAppId AppId_t
- nPublishedFileID PublishedFileId_t
Returns
StartPlaytimeTracking(PublishedFileId_t[], uint)
usage tracking
public static SteamAPICall_t StartPlaytimeTracking(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)Parameters
- pvecPublishedFileID PublishedFileId_t[]
- unNumPublishedFileIDs uint
Returns
StopPlaytimeTracking(PublishedFileId_t[], uint)
public static SteamAPICall_t StopPlaytimeTracking(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)Parameters
- pvecPublishedFileID PublishedFileId_t[]
- unNumPublishedFileIDs uint
Returns
StopPlaytimeTrackingForAllItems()
public static SteamAPICall_t StopPlaytimeTrackingForAllItems()Returns
SubmitItemUpdate(UGCUpdateHandle_t, string)
commit update process started with StartItemUpdate()
public static SteamAPICall_t SubmitItemUpdate(UGCUpdateHandle_t handle, string pchChangeNote)Parameters
- handle UGCUpdateHandle_t
- pchChangeNote string
Returns
SubscribeItem(PublishedFileId_t)
subscribe to this item, will be installed ASAP
public static SteamAPICall_t SubscribeItem(PublishedFileId_t nPublishedFileID)Parameters
- nPublishedFileID PublishedFileId_t
Returns
SuspendDownloads(bool)
SuspendDownloads( true ) will suspend all workshop downloads until SuspendDownloads( false ) is called or the game ends
public static void SuspendDownloads(bool bSuspend)Parameters
- bSuspend bool
UnsubscribeItem(PublishedFileId_t)
unsubscribe from this item, will be uninstalled after game quits
public static SteamAPICall_t UnsubscribeItem(PublishedFileId_t nPublishedFileID)Parameters
- nPublishedFileID PublishedFileId_t
Returns
UpdateItemPreviewFile(UGCUpdateHandle_t, uint, string)
updates an existing preview file for this item. pszPreviewFile points to local file, which must be under 1MB in size
public static bool UpdateItemPreviewFile(UGCUpdateHandle_t handle, uint index, string pszPreviewFile)Parameters
- handle UGCUpdateHandle_t
- index uint
- pszPreviewFile string
Returns
UpdateItemPreviewVideo(UGCUpdateHandle_t, uint, string)
updates an existing preview video for this item
public static bool UpdateItemPreviewVideo(UGCUpdateHandle_t handle, uint index, string pszVideoID)Parameters
- handle UGCUpdateHandle_t
- index uint
- pszVideoID string
Returns