Class SteamGameServerUGC

Purpose: Steam UGC support API

Inheritance

object

SteamGameServerUGC

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

public static class SteamGameServerUGC

Methods

AddAppDependency(PublishedFileId_t, AppId_t)

add/remove app dependence/requirements (usually DLC)

Declaration

public static SteamAPICall_t AddAppDependency(PublishedFileId_t nPublishedFileID, AppId_t nAppID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::AddAppDependency.
AppId_t	nAppID	Passed through to ISteamGameServerUGC::AddAppDependency.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::AddAppDependency returns.

AddAppDependencyAsync(PublishedFileId_t, AppId_t)

Async version of AddAppDependency(PublishedFileId_t, AppId_t).

Declaration

public static Task<AddAppDependencyResult_t> AddAppDependencyAsync(PublishedFileId_t nPublishedFileID, AppId_t nAppID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::AddAppDependency.
AppId_t	nAppID	Passed through to ISteamGameServerUGC::AddAppDependency.

Returns

Type	Description
Task<AddAppDependencyResult_t>	The AddAppDependencyResult_t Steam reports once the call completes.

AddContentDescriptor(UGCUpdateHandle_t, EUGCContentDescriptorID)

Calls the Steamworks ISteamGameServerUGC::AddContentDescriptor method.

Declaration

public static bool AddContentDescriptor(UGCUpdateHandle_t handle, EUGCContentDescriptorID descid)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::AddContentDescriptor.
EUGCContentDescriptorID	descid	Passed through to ISteamGameServerUGC::AddContentDescriptor.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddContentDescriptor returns.

AddDependency(PublishedFileId_t, PublishedFileId_t)

parent-child relationship or dependency management

Declaration

public static SteamAPICall_t AddDependency(PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nParentPublishedFileID	Passed through to ISteamGameServerUGC::AddDependency.
PublishedFileId_t	nChildPublishedFileID	Passed through to ISteamGameServerUGC::AddDependency.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::AddDependency returns.

AddDependencyAsync(PublishedFileId_t, PublishedFileId_t)

Async version of AddDependency(PublishedFileId_t, PublishedFileId_t).

Declaration

public static Task<AddUGCDependencyResult_t> AddDependencyAsync(PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nParentPublishedFileID	Passed through to ISteamGameServerUGC::AddDependency.
PublishedFileId_t	nChildPublishedFileID	Passed through to ISteamGameServerUGC::AddDependency.

Returns

Type	Description
Task<AddUGCDependencyResult_t>	The AddUGCDependencyResult_t Steam reports once the call completes.

AddExcludedTag(UGCQueryHandle_t, string)

Calls the Steamworks ISteamGameServerUGC::AddExcludedTag method.

Declaration

public static bool AddExcludedTag(UGCQueryHandle_t handle, string pTagName)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::AddExcludedTag.
string	pTagName	Passed through to ISteamGameServerUGC::AddExcludedTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddExcludedTag returns.

AddItemKeyValueTag(UGCUpdateHandle_t, string, string)

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

Declaration

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

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::AddItemKeyValueTag.
string	pchKey	Passed through to ISteamGameServerUGC::AddItemKeyValueTag.
string	pchValue	Passed through to ISteamGameServerUGC::AddItemKeyValueTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddItemKeyValueTag returns.

AddItemPreviewFile(UGCUpdateHandle_t, string, EItemPreviewType)

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

Declaration

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

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::AddItemPreviewFile.
string	pszPreviewFile	Passed through to ISteamGameServerUGC::AddItemPreviewFile.
EItemPreviewType	type	Passed through to ISteamGameServerUGC::AddItemPreviewFile.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddItemPreviewFile returns.

AddItemPreviewVideo(UGCUpdateHandle_t, string)

add preview video for this item

Declaration

public static bool AddItemPreviewVideo(UGCUpdateHandle_t handle, string pszVideoID)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::AddItemPreviewVideo.
string	pszVideoID	Passed through to ISteamGameServerUGC::AddItemPreviewVideo.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddItemPreviewVideo returns.

AddItemToFavorites(AppId_t, PublishedFileId_t)

Calls the Steamworks ISteamGameServerUGC::AddItemToFavorites method.

Declaration

public static SteamAPICall_t AddItemToFavorites(AppId_t nAppId, PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
AppId_t	nAppId	Passed through to ISteamGameServerUGC::AddItemToFavorites.
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::AddItemToFavorites.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::AddItemToFavorites returns.

AddItemToFavoritesAsync(AppId_t, PublishedFileId_t)

Async version of AddItemToFavorites(AppId_t, PublishedFileId_t).

Declaration

public static Task<UserFavoriteItemsListChanged_t> AddItemToFavoritesAsync(AppId_t nAppId, PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
AppId_t	nAppId	Passed through to ISteamGameServerUGC::AddItemToFavorites.
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::AddItemToFavorites.

Returns

Type	Description
Task<UserFavoriteItemsListChanged_t>	The UserFavoriteItemsListChanged_t Steam reports once the call completes.

AddRequiredKeyValueTag(UGCQueryHandle_t, string, string)

Calls the Steamworks ISteamGameServerUGC::AddRequiredKeyValueTag method.

Declaration

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

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::AddRequiredKeyValueTag.
string	pKey	Passed through to ISteamGameServerUGC::AddRequiredKeyValueTag.
string	pValue	Passed through to ISteamGameServerUGC::AddRequiredKeyValueTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddRequiredKeyValueTag returns.

AddRequiredTag(UGCQueryHandle_t, string)

Options to set for querying UGC

Declaration

public static bool AddRequiredTag(UGCQueryHandle_t handle, string pTagName)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::AddRequiredTag.
string	pTagName	Passed through to ISteamGameServerUGC::AddRequiredTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddRequiredTag returns.

AddRequiredTagGroup(UGCQueryHandle_t, IList<string>)

match any of the tags in this group

Declaration

public static bool AddRequiredTagGroup(UGCQueryHandle_t handle, IList<string> pTagGroups)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::AddRequiredTagGroup.
IList<string>	pTagGroups	Passed through to ISteamGameServerUGC::AddRequiredTagGroup.

Returns

Type	Description
bool	The value ISteamGameServerUGC::AddRequiredTagGroup 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

Declaration

public static bool BInitWorkshopForGameServer(DepotId_t unWorkshopDepotID, string pszFolder)

Parameters

Type	Name	Description
DepotId_t	unWorkshopDepotID	Passed through to ISteamGameServerUGC::BInitWorkshopForGameServer.
string	pszFolder	Passed through to ISteamGameServerUGC::BInitWorkshopForGameServer.

Returns

Type	Description
bool	The value ISteamGameServerUGC::BInitWorkshopForGameServer returns.

CreateItem(AppId_t, EWorkshopFileType)

Steam Workshop Creator API create new item for this app with no content attached yet

Declaration

public static SteamAPICall_t CreateItem(AppId_t nConsumerAppId, EWorkshopFileType eFileType)

Parameters

Type	Name	Description
AppId_t	nConsumerAppId	Passed through to ISteamGameServerUGC::CreateItem.
EWorkshopFileType	eFileType	Passed through to ISteamGameServerUGC::CreateItem.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::CreateItem returns.

CreateItemAsync(AppId_t, EWorkshopFileType)

Async version of CreateItem(AppId_t, EWorkshopFileType).

Declaration

public static Task<CreateItemResult_t> CreateItemAsync(AppId_t nConsumerAppId, EWorkshopFileType eFileType)

Parameters

Type	Name	Description
AppId_t	nConsumerAppId	Passed through to ISteamGameServerUGC::CreateItem.
EWorkshopFileType	eFileType	Passed through to ISteamGameServerUGC::CreateItem.

Returns

Type	Description
Task<CreateItemResult_t>	The CreateItemResult_t Steam reports once the call completes.

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.

Declaration

public static UGCQueryHandle_t CreateQueryAllUGCRequest(EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, string pchCursor = null)

Parameters

Type	Name	Description
EUGCQuery	eQueryType	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
EUGCMatchingUGCType	eMatchingeMatchingUGCTypeFileType	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
AppId_t	nCreatorAppID	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
AppId_t	nConsumerAppID	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
string	pchCursor	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.

Returns

Type	Description
UGCQueryHandle_t	The value ISteamGameServerUGC::CreateQueryAllUGCRequest returns.

CreateQueryAllUGCRequest(EUGCQuery, EUGCMatchingUGCType, AppId_t, AppId_t, uint)

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.

Declaration

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

Parameters

Type	Name	Description
EUGCQuery	eQueryType	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
EUGCMatchingUGCType	eMatchingeMatchingUGCTypeFileType	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
AppId_t	nCreatorAppID	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
AppId_t	nConsumerAppID	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.
uint	unPage	Passed through to ISteamGameServerUGC::CreateQueryAllUGCRequest.

Returns

Type	Description
UGCQueryHandle_t	The value ISteamGameServerUGC::CreateQueryAllUGCRequest returns.

CreateQueryUGCDetailsRequest(PublishedFileId_t[], uint)

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

Declaration

public static UGCQueryHandle_t CreateQueryUGCDetailsRequest(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::CreateQueryUGCDetailsRequest.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::CreateQueryUGCDetailsRequest.

Returns

Type	Description
UGCQueryHandle_t	The value ISteamGameServerUGC::CreateQueryUGCDetailsRequest 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.

Declaration

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

Parameters

Type	Name	Description
AccountID_t	unAccountID	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.
EUserUGCList	eListType	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.
EUGCMatchingUGCType	eMatchingUGCType	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.
EUserUGCListSortOrder	eSortOrder	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.
AppId_t	nCreatorAppID	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.
AppId_t	nConsumerAppID	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.
uint	unPage	Passed through to ISteamGameServerUGC::CreateQueryUserUGCRequest.

Returns

Type	Description
UGCQueryHandle_t	The value ISteamGameServerUGC::CreateQueryUserUGCRequest returns.

DeleteItem(PublishedFileId_t)

delete the item without prompting the user

Declaration

public static SteamAPICall_t DeleteItem(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::DeleteItem.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::DeleteItem returns.

DeleteItemAsync(PublishedFileId_t)

Async version of DeleteItem(PublishedFileId_t).

Declaration

public static Task<DeleteItemResult_t> DeleteItemAsync(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::DeleteItem.

Returns

Type	Description
Task<DeleteItemResult_t>	The DeleteItemResult_t Steam reports once the call completes.

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.

Declaration

public static bool DownloadItem(PublishedFileId_t nPublishedFileID, bool bHighPriority)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::DownloadItem.
bool	bHighPriority	Passed through to ISteamGameServerUGC::DownloadItem.

Returns

Type	Description
bool	The value ISteamGameServerUGC::DownloadItem 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

Declaration

public static SteamAPICall_t GetAppDependencies(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetAppDependencies.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::GetAppDependencies returns.

GetAppDependenciesAsync(PublishedFileId_t)

Async version of GetAppDependencies(PublishedFileId_t).

Declaration

public static Task<GetAppDependenciesResult_t> GetAppDependenciesAsync(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetAppDependencies.

Returns

Type	Description
Task<GetAppDependenciesResult_t>	The GetAppDependenciesResult_t Steam reports once the call completes.

GetDownloadedItems(out PublishedFileId_t, uint)

Returns the ids of the items downloaded

Declaration

public static uint GetDownloadedItems(out PublishedFileId_t pvecPublishedFileIDs, uint cMaxEntries)

Parameters

Type	Name	Description
PublishedFileId_t	pvecPublishedFileIDs	Passed through to ISteamGameServerUGC::GetDownloadedItems.
uint	cMaxEntries	Passed through to ISteamGameServerUGC::GetDownloadedItems.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetDownloadedItems 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

Declaration

public static bool GetItemDownloadInfo(PublishedFileId_t nPublishedFileID, out ulong punBytesDownloaded, out ulong punBytesTotal)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetItemDownloadInfo.
ulong	punBytesDownloaded	Passed through to ISteamGameServerUGC::GetItemDownloadInfo.
ulong	punBytesTotal	Passed through to ISteamGameServerUGC::GetItemDownloadInfo.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetItemDownloadInfo 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)

Declaration

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

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetItemInstallInfo.
ulong	punSizeOnDisk	Passed through to ISteamGameServerUGC::GetItemInstallInfo.
string	pchFolder	Receives the string ISteamGameServerUGC::GetItemInstallInfo writes.
uint	cchFolderSize	Passed through to ISteamGameServerUGC::GetItemInstallInfo.
uint	punTimeStamp	Passed through to ISteamGameServerUGC::GetItemInstallInfo.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetItemInstallInfo returns.

GetItemState(PublishedFileId_t)

get EItemState flags about item on this client

Declaration

public static uint GetItemState(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetItemState.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetItemState returns.

GetItemUpdateProgress(UGCUpdateHandle_t, out ulong, out ulong)

Calls the Steamworks ISteamGameServerUGC::GetItemUpdateProgress method.

Declaration

public static EItemUpdateStatus GetItemUpdateProgress(UGCUpdateHandle_t handle, out ulong punBytesProcessed, out ulong punBytesTotal)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::GetItemUpdateProgress.
ulong	punBytesProcessed	Passed through to ISteamGameServerUGC::GetItemUpdateProgress.
ulong	punBytesTotal	Passed through to ISteamGameServerUGC::GetItemUpdateProgress.

Returns

Type	Description
EItemUpdateStatus	The value ISteamGameServerUGC::GetItemUpdateProgress returns.

GetNumDownloadedItems()

Returns the number of items actually downloaded locally

Declaration

public static uint GetNumDownloadedItems()

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetNumDownloadedItems returns.

GetNumSubscribedItems(bool)

number of subscribed items

Declaration

public static uint GetNumSubscribedItems(bool bIncludeLocallyDisabled = false)

Parameters

Type	Name	Description
bool	bIncludeLocallyDisabled	Passed through to ISteamGameServerUGC::GetNumSubscribedItems.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetNumSubscribedItems 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)

Declaration

public static uint GetNumSupportedGameVersions(UGCQueryHandle_t handle, uint index)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetNumSupportedGameVersions.
uint	index	Passed through to ISteamGameServerUGC::GetNumSupportedGameVersions.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetNumSupportedGameVersions returns.

GetQueryUGCAdditionalPreview(UGCQueryHandle_t, uint, uint, out string, uint, out string, uint, out EItemPreviewType)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCAdditionalPreview method.

Declaration

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

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCAdditionalPreview.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCAdditionalPreview.
uint	previewIndex	Passed through to ISteamGameServerUGC::GetQueryUGCAdditionalPreview.
string	pchURLOrVideoID	Receives the string ISteamGameServerUGC::GetQueryUGCAdditionalPreview writes.
uint	cchURLSize	Passed through to ISteamGameServerUGC::GetQueryUGCAdditionalPreview.
string	pchOriginalFileName	Receives the string ISteamGameServerUGC::GetQueryUGCAdditionalPreview writes.
uint	cchOriginalFileNameSize	Passed through to ISteamGameServerUGC::GetQueryUGCAdditionalPreview.
EItemPreviewType	pPreviewType	Passed through to ISteamGameServerUGC::GetQueryUGCAdditionalPreview.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCAdditionalPreview returns.

GetQueryUGCChildren(UGCQueryHandle_t, uint, PublishedFileId_t[], uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCChildren method.

Declaration

public static bool GetQueryUGCChildren(UGCQueryHandle_t handle, uint index, PublishedFileId_t[] pvecPublishedFileID, uint cMaxEntries)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCChildren.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCChildren.
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::GetQueryUGCChildren.
uint	cMaxEntries	Passed through to ISteamGameServerUGC::GetQueryUGCChildren.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCChildren returns.

GetQueryUGCContentDescriptors(UGCQueryHandle_t, uint, EUGCContentDescriptorID[], uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCContentDescriptors method.

Declaration

public static uint GetQueryUGCContentDescriptors(UGCQueryHandle_t handle, uint index, EUGCContentDescriptorID[] pvecDescriptors, uint cMaxEntries)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCContentDescriptors.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCContentDescriptors.
EUGCContentDescriptorID[]	pvecDescriptors	Passed through to ISteamGameServerUGC::GetQueryUGCContentDescriptors.
uint	cMaxEntries	Passed through to ISteamGameServerUGC::GetQueryUGCContentDescriptors.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetQueryUGCContentDescriptors 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.

Declaration

public static bool GetQueryUGCKeyValueTag(UGCQueryHandle_t handle, uint index, string pchKey, out string pchValue, uint cchValueSize)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
string	pchKey	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
string	pchValue	Receives the string ISteamGameServerUGC::GetQueryUGCKeyValueTag writes.
uint	cchValueSize	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCKeyValueTag returns.

GetQueryUGCKeyValueTag(UGCQueryHandle_t, uint, uint, out string, uint, 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.

Declaration

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

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
uint	keyValueTagIndex	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
string	pchKey	Receives the string ISteamGameServerUGC::GetQueryUGCKeyValueTag writes.
uint	cchKeySize	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.
string	pchValue	Receives the string ISteamGameServerUGC::GetQueryUGCKeyValueTag writes.
uint	cchValueSize	Passed through to ISteamGameServerUGC::GetQueryUGCKeyValueTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCKeyValueTag returns.

GetQueryUGCMetadata(UGCQueryHandle_t, uint, out string, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCMetadata method.

Declaration

public static bool GetQueryUGCMetadata(UGCQueryHandle_t handle, uint index, out string pchMetadata, uint cchMetadatasize)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCMetadata.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCMetadata.
string	pchMetadata	Receives the string ISteamGameServerUGC::GetQueryUGCMetadata writes.
uint	cchMetadatasize	Passed through to ISteamGameServerUGC::GetQueryUGCMetadata.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCMetadata returns.

GetQueryUGCNumAdditionalPreviews(UGCQueryHandle_t, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCNumAdditionalPreviews method.

Declaration

public static uint GetQueryUGCNumAdditionalPreviews(UGCQueryHandle_t handle, uint index)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCNumAdditionalPreviews.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCNumAdditionalPreviews.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetQueryUGCNumAdditionalPreviews returns.

GetQueryUGCNumKeyValueTags(UGCQueryHandle_t, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCNumKeyValueTags method.

Declaration

public static uint GetQueryUGCNumKeyValueTags(UGCQueryHandle_t handle, uint index)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCNumKeyValueTags.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCNumKeyValueTags.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetQueryUGCNumKeyValueTags returns.

GetQueryUGCNumTags(UGCQueryHandle_t, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCNumTags method.

Declaration

public static uint GetQueryUGCNumTags(UGCQueryHandle_t handle, uint index)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCNumTags.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCNumTags.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetQueryUGCNumTags returns.

GetQueryUGCPreviewURL(UGCQueryHandle_t, uint, out string, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCPreviewURL method.

Declaration

public static bool GetQueryUGCPreviewURL(UGCQueryHandle_t handle, uint index, out string pchURL, uint cchURLSize)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCPreviewURL.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCPreviewURL.
string	pchURL	Receives the string ISteamGameServerUGC::GetQueryUGCPreviewURL writes.
uint	cchURLSize	Passed through to ISteamGameServerUGC::GetQueryUGCPreviewURL.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCPreviewURL returns.

GetQueryUGCResult(UGCQueryHandle_t, uint, out SteamUGCDetails_t)

Retrieve an individual result after receiving the callback for querying UGC

Declaration

public static bool GetQueryUGCResult(UGCQueryHandle_t handle, uint index, out SteamUGCDetails_t pDetails)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCResult.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCResult.
SteamUGCDetails_t	pDetails	Passed through to ISteamGameServerUGC::GetQueryUGCResult.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCResult returns.

GetQueryUGCStatistic(UGCQueryHandle_t, uint, EItemStatistic, out ulong)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCStatistic method.

Declaration

public static bool GetQueryUGCStatistic(UGCQueryHandle_t handle, uint index, EItemStatistic eStatType, out ulong pStatValue)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCStatistic.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCStatistic.
EItemStatistic	eStatType	Passed through to ISteamGameServerUGC::GetQueryUGCStatistic.
ulong	pStatValue	Passed through to ISteamGameServerUGC::GetQueryUGCStatistic.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCStatistic returns.

GetQueryUGCTag(UGCQueryHandle_t, uint, uint, out string, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCTag method.

Declaration

public static bool GetQueryUGCTag(UGCQueryHandle_t handle, uint index, uint indexTag, out string pchValue, uint cchValueSize)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCTag.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCTag.
uint	indexTag	Passed through to ISteamGameServerUGC::GetQueryUGCTag.
string	pchValue	Receives the string ISteamGameServerUGC::GetQueryUGCTag writes.
uint	cchValueSize	Passed through to ISteamGameServerUGC::GetQueryUGCTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCTag returns.

GetQueryUGCTagDisplayName(UGCQueryHandle_t, uint, uint, out string, uint)

Calls the Steamworks ISteamGameServerUGC::GetQueryUGCTagDisplayName method.

Declaration

public static bool GetQueryUGCTagDisplayName(UGCQueryHandle_t handle, uint index, uint indexTag, out string pchValue, uint cchValueSize)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetQueryUGCTagDisplayName.
uint	index	Passed through to ISteamGameServerUGC::GetQueryUGCTagDisplayName.
uint	indexTag	Passed through to ISteamGameServerUGC::GetQueryUGCTagDisplayName.
string	pchValue	Receives the string ISteamGameServerUGC::GetQueryUGCTagDisplayName writes.
uint	cchValueSize	Passed through to ISteamGameServerUGC::GetQueryUGCTagDisplayName.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetQueryUGCTagDisplayName returns.

GetSubscribedItems(PublishedFileId_t[], uint, bool)

all subscribed item PublishFileIDs

Declaration

public static uint GetSubscribedItems(PublishedFileId_t[] pvecPublishedFileID, uint cMaxEntries, bool bIncludeLocallyDisabled = false)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::GetSubscribedItems.
uint	cMaxEntries	Passed through to ISteamGameServerUGC::GetSubscribedItems.
bool	bIncludeLocallyDisabled	Passed through to ISteamGameServerUGC::GetSubscribedItems.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetSubscribedItems returns.

GetSupportedGameVersionData(UGCQueryHandle_t, uint, uint, out string, out string, uint)

Calls the Steamworks ISteamGameServerUGC::GetSupportedGameVersionData method.

Declaration

public static bool GetSupportedGameVersionData(UGCQueryHandle_t handle, uint index, uint versionIndex, out string pchGameBranchMin, out string pchGameBranchMax, uint cchGameBranchSize)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::GetSupportedGameVersionData.
uint	index	Passed through to ISteamGameServerUGC::GetSupportedGameVersionData.
uint	versionIndex	Passed through to ISteamGameServerUGC::GetSupportedGameVersionData.
string	pchGameBranchMin	Receives the string ISteamGameServerUGC::GetSupportedGameVersionData writes.
string	pchGameBranchMax	Receives the string ISteamGameServerUGC::GetSupportedGameVersionData writes.
uint	cchGameBranchSize	Passed through to ISteamGameServerUGC::GetSupportedGameVersionData.

Returns

Type	Description
bool	The value ISteamGameServerUGC::GetSupportedGameVersionData returns.

GetUserContentDescriptorPreferences(EUGCContentDescriptorID[], uint)

Return the user's community content descriptor preferences

Declaration

public static uint GetUserContentDescriptorPreferences(EUGCContentDescriptorID[] pvecDescriptors, uint cMaxEntries)

Parameters

Type	Name	Description
EUGCContentDescriptorID[]	pvecDescriptors	Passed through to ISteamGameServerUGC::GetUserContentDescriptorPreferences.
uint	cMaxEntries	Passed through to ISteamGameServerUGC::GetUserContentDescriptorPreferences.

Returns

Type	Description
uint	The value ISteamGameServerUGC::GetUserContentDescriptorPreferences returns.

GetUserItemVote(PublishedFileId_t)

Calls the Steamworks ISteamGameServerUGC::GetUserItemVote method.

Declaration

public static SteamAPICall_t GetUserItemVote(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetUserItemVote.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::GetUserItemVote returns.

GetUserItemVoteAsync(PublishedFileId_t)

Async version of GetUserItemVote(PublishedFileId_t).

Declaration

public static Task<GetUserItemVoteResult_t> GetUserItemVoteAsync(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::GetUserItemVote.

Returns

Type	Description
Task<GetUserItemVoteResult_t>	The GetUserItemVoteResult_t Steam reports once the call completes.

GetWorkshopEULAStatus()

Retrieve information related to the user's acceptance or not of the app's specific Workshop EULA

Declaration

public static SteamAPICall_t GetWorkshopEULAStatus()

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::GetWorkshopEULAStatus returns.

GetWorkshopEULAStatusAsync()

Async version of GetWorkshopEULAStatus().

Declaration

public static Task<WorkshopEULAStatus_t> GetWorkshopEULAStatusAsync()

Returns

Type	Description
Task<WorkshopEULAStatus_t>	The WorkshopEULAStatus_t Steam reports once the call completes.

MarkDownloadedItemAsUnused(PublishedFileId_t)

Tells the client to no longer try to keep the item in its local cache, unless it was subscribed to by other users on this machine

Declaration

public static bool MarkDownloadedItemAsUnused(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::MarkDownloadedItemAsUnused.

Returns

Type	Description
bool	The value ISteamGameServerUGC::MarkDownloadedItemAsUnused returns.

ReleaseQueryUGCRequest(UGCQueryHandle_t)

Release the request to free up memory, after retrieving results

Declaration

public static bool ReleaseQueryUGCRequest(UGCQueryHandle_t handle)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::ReleaseQueryUGCRequest.

Returns

Type	Description
bool	The value ISteamGameServerUGC::ReleaseQueryUGCRequest returns.

RemoveAllItemKeyValueTags(UGCUpdateHandle_t)

remove all existing key-value tags (you can add new ones via the AddItemKeyValueTag function)

Declaration

public static bool RemoveAllItemKeyValueTags(UGCUpdateHandle_t handle)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::RemoveAllItemKeyValueTags.

Returns

Type	Description
bool	The value ISteamGameServerUGC::RemoveAllItemKeyValueTags returns.

RemoveAppDependency(PublishedFileId_t, AppId_t)

Calls the Steamworks ISteamGameServerUGC::RemoveAppDependency method.

Declaration

public static SteamAPICall_t RemoveAppDependency(PublishedFileId_t nPublishedFileID, AppId_t nAppID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::RemoveAppDependency.
AppId_t	nAppID	Passed through to ISteamGameServerUGC::RemoveAppDependency.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::RemoveAppDependency returns.

RemoveAppDependencyAsync(PublishedFileId_t, AppId_t)

Async version of RemoveAppDependency(PublishedFileId_t, AppId_t).

Declaration

public static Task<RemoveAppDependencyResult_t> RemoveAppDependencyAsync(PublishedFileId_t nPublishedFileID, AppId_t nAppID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::RemoveAppDependency.
AppId_t	nAppID	Passed through to ISteamGameServerUGC::RemoveAppDependency.

Returns

Type	Description
Task<RemoveAppDependencyResult_t>	The RemoveAppDependencyResult_t Steam reports once the call completes.

RemoveContentDescriptor(UGCUpdateHandle_t, EUGCContentDescriptorID)

Calls the Steamworks ISteamGameServerUGC::RemoveContentDescriptor method.

Declaration

public static bool RemoveContentDescriptor(UGCUpdateHandle_t handle, EUGCContentDescriptorID descid)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::RemoveContentDescriptor.
EUGCContentDescriptorID	descid	Passed through to ISteamGameServerUGC::RemoveContentDescriptor.

Returns

Type	Description
bool	The value ISteamGameServerUGC::RemoveContentDescriptor returns.

RemoveDependency(PublishedFileId_t, PublishedFileId_t)

Calls the Steamworks ISteamGameServerUGC::RemoveDependency method.

Declaration

public static SteamAPICall_t RemoveDependency(PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nParentPublishedFileID	Passed through to ISteamGameServerUGC::RemoveDependency.
PublishedFileId_t	nChildPublishedFileID	Passed through to ISteamGameServerUGC::RemoveDependency.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::RemoveDependency returns.

RemoveDependencyAsync(PublishedFileId_t, PublishedFileId_t)

Async version of RemoveDependency(PublishedFileId_t, PublishedFileId_t).

Declaration

public static Task<RemoveUGCDependencyResult_t> RemoveDependencyAsync(PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nParentPublishedFileID	Passed through to ISteamGameServerUGC::RemoveDependency.
PublishedFileId_t	nChildPublishedFileID	Passed through to ISteamGameServerUGC::RemoveDependency.

Returns

Type	Description
Task<RemoveUGCDependencyResult_t>	The RemoveUGCDependencyResult_t Steam reports once the call completes.

RemoveItemFromFavorites(AppId_t, PublishedFileId_t)

Calls the Steamworks ISteamGameServerUGC::RemoveItemFromFavorites method.

Declaration

public static SteamAPICall_t RemoveItemFromFavorites(AppId_t nAppId, PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
AppId_t	nAppId	Passed through to ISteamGameServerUGC::RemoveItemFromFavorites.
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::RemoveItemFromFavorites.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::RemoveItemFromFavorites returns.

RemoveItemFromFavoritesAsync(AppId_t, PublishedFileId_t)

Async version of RemoveItemFromFavorites(AppId_t, PublishedFileId_t).

Declaration

public static Task<UserFavoriteItemsListChanged_t> RemoveItemFromFavoritesAsync(AppId_t nAppId, PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
AppId_t	nAppId	Passed through to ISteamGameServerUGC::RemoveItemFromFavorites.
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::RemoveItemFromFavorites.

Returns

Type	Description
Task<UserFavoriteItemsListChanged_t>	The UserFavoriteItemsListChanged_t Steam reports once the call completes.

RemoveItemKeyValueTags(UGCUpdateHandle_t, string)

remove any existing key-value tags with the specified key

Declaration

public static bool RemoveItemKeyValueTags(UGCUpdateHandle_t handle, string pchKey)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::RemoveItemKeyValueTags.
string	pchKey	Passed through to ISteamGameServerUGC::RemoveItemKeyValueTags.

Returns

Type	Description
bool	The value ISteamGameServerUGC::RemoveItemKeyValueTags returns.

RemoveItemPreview(UGCUpdateHandle_t, uint)

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

Declaration

public static bool RemoveItemPreview(UGCUpdateHandle_t handle, uint index)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::RemoveItemPreview.
uint	index	Passed through to ISteamGameServerUGC::RemoveItemPreview.

Returns

Type	Description
bool	The value ISteamGameServerUGC::RemoveItemPreview returns.

RequestUGCDetails(PublishedFileId_t, uint)

DEPRECATED - Use CreateQueryUGCDetailsRequest call above instead!

Declaration

public static SteamAPICall_t RequestUGCDetails(PublishedFileId_t nPublishedFileID, uint unMaxAgeSeconds)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::RequestUGCDetails.
uint	unMaxAgeSeconds	Passed through to ISteamGameServerUGC::RequestUGCDetails.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::RequestUGCDetails returns.

RequestUGCDetailsAsync(PublishedFileId_t, uint)

Async version of RequestUGCDetails(PublishedFileId_t, uint).

Declaration

public static Task<SteamUGCRequestUGCDetailsResult_t> RequestUGCDetailsAsync(PublishedFileId_t nPublishedFileID, uint unMaxAgeSeconds)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::RequestUGCDetails.
uint	unMaxAgeSeconds	Passed through to ISteamGameServerUGC::RequestUGCDetails.

Returns

Type	Description
Task<SteamUGCRequestUGCDetailsResult_t>	The SteamUGCRequestUGCDetailsResult_t Steam reports once the call completes.

SendQueryUGCRequest(UGCQueryHandle_t)

Send the query to Steam

Declaration

public static SteamAPICall_t SendQueryUGCRequest(UGCQueryHandle_t handle)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SendQueryUGCRequest.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::SendQueryUGCRequest returns.

SendQueryUGCRequestAsync(UGCQueryHandle_t)

Async version of SendQueryUGCRequest(UGCQueryHandle_t).

Declaration

public static Task<SteamUGCQueryCompleted_t> SendQueryUGCRequestAsync(UGCQueryHandle_t handle)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SendQueryUGCRequest.

Returns

Type	Description
Task<SteamUGCQueryCompleted_t>	The SteamUGCQueryCompleted_t Steam reports once the call completes.

SetAdminQuery(UGCUpdateHandle_t, bool)

admin queries return hidden items

Declaration

public static bool SetAdminQuery(UGCUpdateHandle_t handle, bool bAdminQuery)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetAdminQuery.
bool	bAdminQuery	Passed through to ISteamGameServerUGC::SetAdminQuery.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetAdminQuery returns.

SetAllowCachedResponse(UGCQueryHandle_t, uint)

Calls the Steamworks ISteamGameServerUGC::SetAllowCachedResponse method.

Declaration

public static bool SetAllowCachedResponse(UGCQueryHandle_t handle, uint unMaxAgeSeconds)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetAllowCachedResponse.
uint	unMaxAgeSeconds	Passed through to ISteamGameServerUGC::SetAllowCachedResponse.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetAllowCachedResponse 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.

Declaration

public static bool SetAllowLegacyUpload(UGCUpdateHandle_t handle, bool bAllowLegacyUpload)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetAllowLegacyUpload.
bool	bAllowLegacyUpload	Passed through to ISteamGameServerUGC::SetAllowLegacyUpload.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetAllowLegacyUpload returns.

SetCloudFileNameFilter(UGCQueryHandle_t, string)

Options only for querying user UGC

Declaration

public static bool SetCloudFileNameFilter(UGCQueryHandle_t handle, string pMatchCloudFileName)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetCloudFileNameFilter.
string	pMatchCloudFileName	Passed through to ISteamGameServerUGC::SetCloudFileNameFilter.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetCloudFileNameFilter returns.

SetItemContent(UGCUpdateHandle_t, string)

update item content from this local folder

Declaration

public static bool SetItemContent(UGCUpdateHandle_t handle, string pszContentFolder)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemContent.
string	pszContentFolder	Passed through to ISteamGameServerUGC::SetItemContent.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemContent returns.

SetItemDescription(UGCUpdateHandle_t, string)

change the description of an UGC item

Declaration

public static bool SetItemDescription(UGCUpdateHandle_t handle, string pchDescription)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemDescription.
string	pchDescription	Passed through to ISteamGameServerUGC::SetItemDescription.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemDescription returns.

SetItemMetadata(UGCUpdateHandle_t, string)

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

Declaration

public static bool SetItemMetadata(UGCUpdateHandle_t handle, string pchMetaData)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemMetadata.
string	pchMetaData	Passed through to ISteamGameServerUGC::SetItemMetadata.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemMetadata 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

Declaration

public static bool SetItemPreview(UGCUpdateHandle_t handle, string pszPreviewFile)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemPreview.
string	pszPreviewFile	Passed through to ISteamGameServerUGC::SetItemPreview.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemPreview returns.

SetItemTags(UGCUpdateHandle_t, IList<string>, bool)

change the tags of an UGC item

Declaration

public static bool SetItemTags(UGCUpdateHandle_t updateHandle, IList<string> pTags, bool bAllowAdminTags = false)

Parameters

Type	Name	Description
UGCUpdateHandle_t	updateHandle	Passed through to ISteamGameServerUGC::SetItemTags.
IList<string>	pTags	Passed through to ISteamGameServerUGC::SetItemTags.
bool	bAllowAdminTags	Passed through to ISteamGameServerUGC::SetItemTags.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemTags returns.

SetItemTitle(UGCUpdateHandle_t, string)

change the title of an UGC item

Declaration

public static bool SetItemTitle(UGCUpdateHandle_t handle, string pchTitle)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemTitle.
string	pchTitle	Passed through to ISteamGameServerUGC::SetItemTitle.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemTitle returns.

SetItemUpdateLanguage(UGCUpdateHandle_t, string)

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

Declaration

public static bool SetItemUpdateLanguage(UGCUpdateHandle_t handle, string pchLanguage)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemUpdateLanguage.
string	pchLanguage	Passed through to ISteamGameServerUGC::SetItemUpdateLanguage.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemUpdateLanguage returns.

SetItemVisibility(UGCUpdateHandle_t, ERemoteStoragePublishedFileVisibility)

change the visibility of an UGC item

Declaration

public static bool SetItemVisibility(UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetItemVisibility.
ERemoteStoragePublishedFileVisibility	eVisibility	Passed through to ISteamGameServerUGC::SetItemVisibility.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemVisibility returns.

SetItemsDisabledLocally(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.

Declaration

public static bool SetItemsDisabledLocally(PublishedFileId_t[] pvecPublishedFileIDs, uint unNumPublishedFileIDs, bool bDisabledLocally)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileIDs	Passed through to ISteamGameServerUGC::SetItemsDisabledLocally.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::SetItemsDisabledLocally.
bool	bDisabledLocally	Passed through to ISteamGameServerUGC::SetItemsDisabledLocally.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetItemsDisabledLocally returns.

SetLanguage(UGCQueryHandle_t, string)

Calls the Steamworks ISteamGameServerUGC::SetLanguage method.

Declaration

public static bool SetLanguage(UGCQueryHandle_t handle, string pchLanguage)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetLanguage.
string	pchLanguage	Passed through to ISteamGameServerUGC::SetLanguage.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetLanguage returns.

SetMatchAnyTag(UGCQueryHandle_t, bool)

Options only for querying all UGC

Declaration

public static bool SetMatchAnyTag(UGCQueryHandle_t handle, bool bMatchAnyTag)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetMatchAnyTag.
bool	bMatchAnyTag	Passed through to ISteamGameServerUGC::SetMatchAnyTag.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetMatchAnyTag returns.

SetRankedByTrendDays(UGCQueryHandle_t, uint)

Calls the Steamworks ISteamGameServerUGC::SetRankedByTrendDays method.

Declaration

public static bool SetRankedByTrendDays(UGCQueryHandle_t handle, uint unDays)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetRankedByTrendDays.
uint	unDays	Passed through to ISteamGameServerUGC::SetRankedByTrendDays.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetRankedByTrendDays 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.

Declaration

public static bool SetRequiredGameVersions(UGCUpdateHandle_t handle, string pszGameBranchMin, string pszGameBranchMax)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SetRequiredGameVersions.
string	pszGameBranchMin	Passed through to ISteamGameServerUGC::SetRequiredGameVersions.
string	pszGameBranchMax	Passed through to ISteamGameServerUGC::SetRequiredGameVersions.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetRequiredGameVersions returns.

SetReturnAdditionalPreviews(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnAdditionalPreviews method.

Declaration

public static bool SetReturnAdditionalPreviews(UGCQueryHandle_t handle, bool bReturnAdditionalPreviews)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnAdditionalPreviews.
bool	bReturnAdditionalPreviews	Passed through to ISteamGameServerUGC::SetReturnAdditionalPreviews.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnAdditionalPreviews returns.

SetReturnChildren(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnChildren method.

Declaration

public static bool SetReturnChildren(UGCQueryHandle_t handle, bool bReturnChildren)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnChildren.
bool	bReturnChildren	Passed through to ISteamGameServerUGC::SetReturnChildren.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnChildren returns.

SetReturnKeyValueTags(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnKeyValueTags method.

Declaration

public static bool SetReturnKeyValueTags(UGCQueryHandle_t handle, bool bReturnKeyValueTags)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnKeyValueTags.
bool	bReturnKeyValueTags	Passed through to ISteamGameServerUGC::SetReturnKeyValueTags.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnKeyValueTags returns.

SetReturnLongDescription(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnLongDescription method.

Declaration

public static bool SetReturnLongDescription(UGCQueryHandle_t handle, bool bReturnLongDescription)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnLongDescription.
bool	bReturnLongDescription	Passed through to ISteamGameServerUGC::SetReturnLongDescription.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnLongDescription returns.

SetReturnMetadata(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnMetadata method.

Declaration

public static bool SetReturnMetadata(UGCQueryHandle_t handle, bool bReturnMetadata)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnMetadata.
bool	bReturnMetadata	Passed through to ISteamGameServerUGC::SetReturnMetadata.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnMetadata returns.

SetReturnOnlyIDs(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnOnlyIDs method.

Declaration

public static bool SetReturnOnlyIDs(UGCQueryHandle_t handle, bool bReturnOnlyIDs)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnOnlyIDs.
bool	bReturnOnlyIDs	Passed through to ISteamGameServerUGC::SetReturnOnlyIDs.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnOnlyIDs returns.

SetReturnPlaytimeStats(UGCQueryHandle_t, uint)

Calls the Steamworks ISteamGameServerUGC::SetReturnPlaytimeStats method.

Declaration

public static bool SetReturnPlaytimeStats(UGCQueryHandle_t handle, uint unDays)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnPlaytimeStats.
uint	unDays	Passed through to ISteamGameServerUGC::SetReturnPlaytimeStats.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnPlaytimeStats returns.

SetReturnTotalOnly(UGCQueryHandle_t, bool)

Calls the Steamworks ISteamGameServerUGC::SetReturnTotalOnly method.

Declaration

public static bool SetReturnTotalOnly(UGCQueryHandle_t handle, bool bReturnTotalOnly)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetReturnTotalOnly.
bool	bReturnTotalOnly	Passed through to ISteamGameServerUGC::SetReturnTotalOnly.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetReturnTotalOnly returns.

SetSearchText(UGCQueryHandle_t, string)

Calls the Steamworks ISteamGameServerUGC::SetSearchText method.

Declaration

public static bool SetSearchText(UGCQueryHandle_t handle, string pSearchText)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetSearchText.
string	pSearchText	Passed through to ISteamGameServerUGC::SetSearchText.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetSearchText returns.

SetSubscriptionsLoadOrder(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.

Declaration

public static bool SetSubscriptionsLoadOrder(PublishedFileId_t[] pvecPublishedFileIDs, uint unNumPublishedFileIDs)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileIDs	Passed through to ISteamGameServerUGC::SetSubscriptionsLoadOrder.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::SetSubscriptionsLoadOrder.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetSubscriptionsLoadOrder returns.

SetTimeCreatedDateRange(UGCQueryHandle_t, uint, uint)

Calls the Steamworks ISteamGameServerUGC::SetTimeCreatedDateRange method.

Declaration

public static bool SetTimeCreatedDateRange(UGCQueryHandle_t handle, uint rtStart, uint rtEnd)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetTimeCreatedDateRange.
uint	rtStart	Passed through to ISteamGameServerUGC::SetTimeCreatedDateRange.
uint	rtEnd	Passed through to ISteamGameServerUGC::SetTimeCreatedDateRange.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetTimeCreatedDateRange returns.

SetTimeUpdatedDateRange(UGCQueryHandle_t, uint, uint)

Calls the Steamworks ISteamGameServerUGC::SetTimeUpdatedDateRange method.

Declaration

public static bool SetTimeUpdatedDateRange(UGCQueryHandle_t handle, uint rtStart, uint rtEnd)

Parameters

Type	Name	Description
UGCQueryHandle_t	handle	Passed through to ISteamGameServerUGC::SetTimeUpdatedDateRange.
uint	rtStart	Passed through to ISteamGameServerUGC::SetTimeUpdatedDateRange.
uint	rtEnd	Passed through to ISteamGameServerUGC::SetTimeUpdatedDateRange.

Returns

Type	Description
bool	The value ISteamGameServerUGC::SetTimeUpdatedDateRange returns.

SetUserItemVote(PublishedFileId_t, bool)

Steam Workshop Consumer API

Declaration

public static SteamAPICall_t SetUserItemVote(PublishedFileId_t nPublishedFileID, bool bVoteUp)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::SetUserItemVote.
bool	bVoteUp	Passed through to ISteamGameServerUGC::SetUserItemVote.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::SetUserItemVote returns.

SetUserItemVoteAsync(PublishedFileId_t, bool)

Async version of SetUserItemVote(PublishedFileId_t, bool).

Declaration

public static Task<SetUserItemVoteResult_t> SetUserItemVoteAsync(PublishedFileId_t nPublishedFileID, bool bVoteUp)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::SetUserItemVote.
bool	bVoteUp	Passed through to ISteamGameServerUGC::SetUserItemVote.

Returns

Type	Description
Task<SetUserItemVoteResult_t>	The SetUserItemVoteResult_t Steam reports once the call completes.

ShowWorkshopEULA()

Show the app's latest Workshop EULA to the user in an overlay window, where they can accept it or not

Declaration

public static bool ShowWorkshopEULA()

Returns

Type	Description
bool	The value ISteamGameServerUGC::ShowWorkshopEULA returns.

StartItemUpdate(AppId_t, PublishedFileId_t)

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

Declaration

public static UGCUpdateHandle_t StartItemUpdate(AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
AppId_t	nConsumerAppId	Passed through to ISteamGameServerUGC::StartItemUpdate.
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::StartItemUpdate.

Returns

Type	Description
UGCUpdateHandle_t	The value ISteamGameServerUGC::StartItemUpdate returns.

StartPlaytimeTracking(PublishedFileId_t[], uint)

usage tracking

Declaration

public static SteamAPICall_t StartPlaytimeTracking(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::StartPlaytimeTracking.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::StartPlaytimeTracking.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::StartPlaytimeTracking returns.

StartPlaytimeTrackingAsync(PublishedFileId_t[], uint)

Async version of StartPlaytimeTracking(PublishedFileId_t[], uint).

Declaration

public static Task<StartPlaytimeTrackingResult_t> StartPlaytimeTrackingAsync(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::StartPlaytimeTracking.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::StartPlaytimeTracking.

Returns

Type	Description
Task<StartPlaytimeTrackingResult_t>	The StartPlaytimeTrackingResult_t Steam reports once the call completes.

StopPlaytimeTracking(PublishedFileId_t[], uint)

Calls the Steamworks ISteamGameServerUGC::StopPlaytimeTracking method.

Declaration

public static SteamAPICall_t StopPlaytimeTracking(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::StopPlaytimeTracking.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::StopPlaytimeTracking.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::StopPlaytimeTracking returns.

StopPlaytimeTrackingAsync(PublishedFileId_t[], uint)

Async version of StopPlaytimeTracking(PublishedFileId_t[], uint).

Declaration

public static Task<StopPlaytimeTrackingResult_t> StopPlaytimeTrackingAsync(PublishedFileId_t[] pvecPublishedFileID, uint unNumPublishedFileIDs)

Parameters

Type	Name	Description
PublishedFileId_t[]	pvecPublishedFileID	Passed through to ISteamGameServerUGC::StopPlaytimeTracking.
uint	unNumPublishedFileIDs	Passed through to ISteamGameServerUGC::StopPlaytimeTracking.

Returns

Type	Description
Task<StopPlaytimeTrackingResult_t>	The StopPlaytimeTrackingResult_t Steam reports once the call completes.

StopPlaytimeTrackingForAllItems()

Calls the Steamworks ISteamGameServerUGC::StopPlaytimeTrackingForAllItems method.

Declaration

public static SteamAPICall_t StopPlaytimeTrackingForAllItems()

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::StopPlaytimeTrackingForAllItems returns.

StopPlaytimeTrackingForAllItemsAsync()

Async version of StopPlaytimeTrackingForAllItems().

Declaration

public static Task<StopPlaytimeTrackingResult_t> StopPlaytimeTrackingForAllItemsAsync()

Returns

Type	Description
Task<StopPlaytimeTrackingResult_t>	The StopPlaytimeTrackingResult_t Steam reports once the call completes.

SubmitItemUpdate(UGCUpdateHandle_t, string)

commit update process started with StartItemUpdate()

Declaration

public static SteamAPICall_t SubmitItemUpdate(UGCUpdateHandle_t handle, string pchChangeNote)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SubmitItemUpdate.
string	pchChangeNote	Passed through to ISteamGameServerUGC::SubmitItemUpdate.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::SubmitItemUpdate returns.

SubmitItemUpdateAsync(UGCUpdateHandle_t, string)

Async version of SubmitItemUpdate(UGCUpdateHandle_t, string).

Declaration

public static Task<SubmitItemUpdateResult_t> SubmitItemUpdateAsync(UGCUpdateHandle_t handle, string pchChangeNote)

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::SubmitItemUpdate.
string	pchChangeNote	Passed through to ISteamGameServerUGC::SubmitItemUpdate.

Returns

Type	Description
Task<SubmitItemUpdateResult_t>	The SubmitItemUpdateResult_t Steam reports once the call completes.

SubscribeItem(PublishedFileId_t)

subscribe to this item, will be installed ASAP

Declaration

public static SteamAPICall_t SubscribeItem(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::SubscribeItem.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::SubscribeItem returns.

SubscribeItemAsync(PublishedFileId_t)

Async version of SubscribeItem(PublishedFileId_t).

Declaration

public static Task<RemoteStorageSubscribePublishedFileResult_t> SubscribeItemAsync(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::SubscribeItem.

Returns

Type	Description
Task<RemoteStorageSubscribePublishedFileResult_t>	The RemoteStorageSubscribePublishedFileResult_t Steam reports once the call completes.

SuspendDownloads(bool)

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

Declaration

public static void SuspendDownloads(bool bSuspend)

Parameters

Type	Name	Description
bool	bSuspend	Passed through to ISteamGameServerUGC::SuspendDownloads.

UnsubscribeItem(PublishedFileId_t)

unsubscribe from this item, will be uninstalled after game quits

Declaration

public static SteamAPICall_t UnsubscribeItem(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::UnsubscribeItem.

Returns

Type	Description
SteamAPICall_t	The value ISteamGameServerUGC::UnsubscribeItem returns.

UnsubscribeItemAsync(PublishedFileId_t)

Async version of UnsubscribeItem(PublishedFileId_t).

Declaration

public static Task<RemoteStorageUnsubscribePublishedFileResult_t> UnsubscribeItemAsync(PublishedFileId_t nPublishedFileID)

Parameters

Type	Name	Description
PublishedFileId_t	nPublishedFileID	Passed through to ISteamGameServerUGC::UnsubscribeItem.

Returns

Type	Description
Task<RemoteStorageUnsubscribePublishedFileResult_t>	The RemoteStorageUnsubscribePublishedFileResult_t Steam reports once the call completes.

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

Declaration

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

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::UpdateItemPreviewFile.
uint	index	Passed through to ISteamGameServerUGC::UpdateItemPreviewFile.
string	pszPreviewFile	Passed through to ISteamGameServerUGC::UpdateItemPreviewFile.

Returns

Type	Description
bool	The value ISteamGameServerUGC::UpdateItemPreviewFile returns.

UpdateItemPreviewVideo(UGCUpdateHandle_t, uint, string)

updates an existing preview video for this item

Declaration

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

Parameters

Type	Name	Description
UGCUpdateHandle_t	handle	Passed through to ISteamGameServerUGC::UpdateItemPreviewVideo.
uint	index	Passed through to ISteamGameServerUGC::UpdateItemPreviewVideo.
string	pszVideoID	Passed through to ISteamGameServerUGC::UpdateItemPreviewVideo.

Returns

Type	Description
bool	The value ISteamGameServerUGC::UpdateItemPreviewVideo returns.