SteamUGC

Swift
public struct SteamUGC: Sendable

Steamworks ISteamUGC

Access via ugc through a SteamAPI or SteamGameServerAPI instance.


Topics

func addAppDependency(publishedFileID: PublishedFileID, appID: AppID, completion: (AddAppDependencyResult?) -> Void)

Steamworks ISteamUGC::AddAppDependency(), callback

Declaration
Swift
public func addAppDependency(
    publishedFileID: PublishedFileID, appID: AppID,
    completion: @escaping (AddAppDependencyResult?) -> Void)

func addAppDependency(publishedFileID: PublishedFileID, appID: AppID) async -> AddAppDependencyResult?

Steamworks ISteamUGC::AddAppDependency(), async

Declaration
Swift
public func addAppDependency(publishedFileID: PublishedFileID, appID: AppID)
    async -> AddAppDependencyResult?

func addContentDescriptor(handle: UGCUpdateHandle, descid: UGCContentDescriptorID) -> Bool

Steamworks ISteamUGC::AddContentDescriptor()

Declaration
Swift
public func addContentDescriptor(
    handle: UGCUpdateHandle, descid: UGCContentDescriptorID
) -> Bool

func addDependency(parentPublishedFileID: PublishedFileID, childPublishedFileID: PublishedFileID, completion: (AddUGCDependencyResult?) -> Void)

Steamworks ISteamUGC::AddDependency(), callback

Declaration
Swift
public func addDependency(
    parentPublishedFileID: PublishedFileID,
    childPublishedFileID: PublishedFileID,
    completion: @escaping (AddUGCDependencyResult?) -> Void)

func addDependency(parentPublishedFileID: PublishedFileID, childPublishedFileID: PublishedFileID) async -> AddUGCDependencyResult?

Steamworks ISteamUGC::AddDependency(), async

Declaration
Swift
public func addDependency(
    parentPublishedFileID: PublishedFileID,
    childPublishedFileID: PublishedFileID
) async -> AddUGCDependencyResult?

func addExcludedTag(handle: UGCQueryHandle, tagName: String) -> Bool

Steamworks ISteamUGC::AddExcludedTag()

Declaration
Swift
@discardableResult
public func addExcludedTag(handle: UGCQueryHandle, tagName: String) -> Bool

func addItemKeyValueTag(handle: UGCUpdateHandle, key: String, value: String) -> Bool

Steamworks ISteamUGC::AddItemKeyValueTag()

Declaration
Swift
@discardableResult
public func addItemKeyValueTag(
    handle: UGCUpdateHandle, key: String, value: String
) -> Bool

func addItemPreviewFile(handle: UGCUpdateHandle, previewFile: String, type: ItemPreviewType) -> Bool

Steamworks ISteamUGC::AddItemPreviewFile()

Declaration
Swift
@discardableResult
public func addItemPreviewFile(
    handle: UGCUpdateHandle, previewFile: String, type: ItemPreviewType
) -> Bool

func addItemPreviewVideo(handle: UGCUpdateHandle, videoID: String) -> Bool

Steamworks ISteamUGC::AddItemPreviewVideo()

Declaration
Swift
@discardableResult
public func addItemPreviewVideo(handle: UGCUpdateHandle, videoID: String)
    -> Bool

func addItemToFavorites(appId: AppID, publishedFileID: PublishedFileID, completion: (UserFavoriteItemsListChanged?) -> Void)

Steamworks ISteamUGC::AddItemToFavorites(), callback

Declaration
Swift
public func addItemToFavorites(
    appId: AppID, publishedFileID: PublishedFileID,
    completion: @escaping (UserFavoriteItemsListChanged?) -> Void)

func addItemToFavorites(appId: AppID, publishedFileID: PublishedFileID) async -> UserFavoriteItemsListChanged?

Steamworks ISteamUGC::AddItemToFavorites(), async

Declaration
Swift
public func addItemToFavorites(appId: AppID, publishedFileID: PublishedFileID)
    async -> UserFavoriteItemsListChanged?

func addRequiredKeyValueTag(handle: UGCQueryHandle, key: String, value: String) -> Bool

Steamworks ISteamUGC::AddRequiredKeyValueTag()

Declaration
Swift
@discardableResult
public func addRequiredKeyValueTag(
    handle: UGCQueryHandle, key: String, value: String
) -> Bool

func addRequiredTag(handle: UGCQueryHandle, tagName: String) -> Bool

Steamworks ISteamUGC::AddRequiredTag()

Declaration
Swift
@discardableResult
public func addRequiredTag(handle: UGCQueryHandle, tagName: String) -> Bool

func addRequiredTagGroup(handle: UGCQueryHandle, tagGroups: [String]) -> Bool

Steamworks ISteamUGC::AddRequiredTagGroup()

Declaration
Swift
@discardableResult
public func addRequiredTagGroup(handle: UGCQueryHandle, tagGroups: [String])
    -> Bool

func initWorkshopForGameServer(workshopDepotID: DepotID, folder: String) -> Bool

Steamworks ISteamUGC::BInitWorkshopForGameServer()

Declaration
Swift
public func initWorkshopForGameServer(workshopDepotID: DepotID, folder: String)
    -> Bool

func createItem(consumerAppId: AppID, fileType: WorkshopFileType, completion: (CreateItemResult?) -> Void)

Steamworks ISteamUGC::CreateItem(), callback

Declaration
Swift
public func createItem(
    consumerAppId: AppID, fileType: WorkshopFileType,
    completion: @escaping (CreateItemResult?) -> Void)

func createItem(consumerAppId: AppID, fileType: WorkshopFileType) async -> CreateItemResult?

Steamworks ISteamUGC::CreateItem(), async

Declaration
Swift
public func createItem(consumerAppId: AppID, fileType: WorkshopFileType) async
    -> CreateItemResult?

func createQueryAllUGCRequest(queryType: UGCQuery, matchingeMatchingUGCTypeFileType: UGCMatchingUGCType, creatorAppID: AppID, consumerAppID: AppID, cursor: String) -> UGCQueryHandle

Steamworks ISteamUGC::CreateQueryAllUGCRequest()

Declaration
Swift
public func createQueryAllUGCRequest(
    queryType: UGCQuery, matchingeMatchingUGCTypeFileType: UGCMatchingUGCType,
    creatorAppID: AppID, consumerAppID: AppID, cursor: String
) -> UGCQueryHandle

func createQueryAllUGCRequest(queryType: UGCQuery, matchingeMatchingUGCTypeFileType: UGCMatchingUGCType, creatorAppID: AppID, consumerAppID: AppID, page: Int) -> UGCQueryHandle

Steamworks ISteamUGC::CreateQueryAllUGCRequest()

Declaration
Swift
public func createQueryAllUGCRequest(
    queryType: UGCQuery, matchingeMatchingUGCTypeFileType: UGCMatchingUGCType,
    creatorAppID: AppID, consumerAppID: AppID, page: Int
) -> UGCQueryHandle

func createQueryUGCDetailsRequest(publishedFileID: [PublishedFileID]) -> UGCQueryHandle

Steamworks ISteamUGC::CreateQueryUGCDetailsRequest()

Declaration
Swift
public func createQueryUGCDetailsRequest(publishedFileID: [PublishedFileID])
    -> UGCQueryHandle

func createQueryUserUGCRequest(accountID: AccountID, listType: UserUGCList, matchingUGCType: UGCMatchingUGCType, sortOrder: UserUGCListSortOrder, creatorAppID: AppID, consumerAppID: AppID, page: Int) -> UGCQueryHandle

Steamworks ISteamUGC::CreateQueryUserUGCRequest()

Declaration
Swift
public func createQueryUserUGCRequest(
    accountID: AccountID, listType: UserUGCList,
    matchingUGCType: UGCMatchingUGCType, sortOrder: UserUGCListSortOrder,
    creatorAppID: AppID, consumerAppID: AppID, page: Int
) -> UGCQueryHandle

func deleteItem(publishedFileID: PublishedFileID, completion: (DeleteItemResult?) -> Void)

Steamworks ISteamUGC::DeleteItem(), callback

Declaration
Swift
public func deleteItem(
    publishedFileID: PublishedFileID,
    completion: @escaping (DeleteItemResult?) -> Void)

func deleteItem(publishedFileID: PublishedFileID) async -> DeleteItemResult?

Steamworks ISteamUGC::DeleteItem(), async

Declaration
Swift
public func deleteItem(publishedFileID: PublishedFileID) async
    -> DeleteItemResult?

func downloadItem(publishedFileID: PublishedFileID, highPriority: Bool) -> Bool

Steamworks ISteamUGC::DownloadItem()

Declaration
Swift
public func downloadItem(publishedFileID: PublishedFileID, highPriority: Bool)
    -> Bool

func getAppDependencies(publishedFileID: PublishedFileID, completion: (GetAppDependenciesResult?) -> Void)

Steamworks ISteamUGC::GetAppDependencies(), callback

Declaration
Swift
public func getAppDependencies(
    publishedFileID: PublishedFileID,
    completion: @escaping (GetAppDependenciesResult?) -> Void)

func getAppDependencies(publishedFileID: PublishedFileID) async -> GetAppDependenciesResult?

Steamworks ISteamUGC::GetAppDependencies(), async

Declaration
Swift
public func getAppDependencies(publishedFileID: PublishedFileID) async
    -> GetAppDependenciesResult?

func getItemDownloadInfo(publishedFileID: PublishedFileID) -> (rc: Bool, bytesDownloaded: UInt64, bytesTotal: UInt64)

Steamworks ISteamUGC::GetItemDownloadInfo()

Declaration
Swift
public func getItemDownloadInfo(publishedFileID: PublishedFileID) -> (
    rc: Bool, bytesDownloaded: UInt64, bytesTotal: UInt64
)

func getItemInstallInfo(publishedFileID: PublishedFileID, folderSize: Int) -> (rc: Bool, sizeOnDisk: UInt64, folder: String, timeStamp: RTime32)

Steamworks ISteamUGC::GetItemInstallInfo()

Declaration
Swift
public func getItemInstallInfo(
    publishedFileID: PublishedFileID,
    folderSize: Int = SteamConstants.filenameMaxSize
) -> (rc: Bool, sizeOnDisk: UInt64, folder: String, timeStamp: RTime32)

func getItemState(publishedFileID: PublishedFileID) -> ItemState

Steamworks ISteamUGC::GetItemState()

Declaration
Swift
public func getItemState(publishedFileID: PublishedFileID) -> ItemState

func getItemUpdateProgress(handle: UGCUpdateHandle) -> (rc: ItemUpdateStatus, bytesProcessed: UInt64, bytesTotal: UInt64)

Steamworks ISteamUGC::GetItemUpdateProgress()

Declaration
Swift
public func getItemUpdateProgress(handle: UGCUpdateHandle) -> (
    rc: ItemUpdateStatus, bytesProcessed: UInt64, bytesTotal: UInt64
)

func getNumSubscribedItems() -> Int

Steamworks ISteamUGC::GetNumSubscribedItems()

Declaration
Swift
public func getNumSubscribedItems() -> Int

func getQueryUGCKeyValueTag(handle: UGCQueryHandle, index: Int, key: String, valueSize: Int) -> (rc: Bool, value: String)

Steamworks ISteamUGC::GetQueryUGCKeyValueTag()

Declaration
Swift
public func getQueryUGCKeyValueTag(
    handle: UGCQueryHandle, index: Int, key: String,
    valueSize: Int = SteamConstants.ugcKeyValueMaxSize + 1
) -> (rc: Bool, value: String)

func getQueryUGCAdditionalPreview(handle: UGCQueryHandle, index: Int, previewIndex: Int, urlSize: Int, returnOriginalFileName: Bool, originalFileNameSize: Int) -> (rc: Bool, urlOrVideoID: String, originalFileName: String, previewType: ItemPreviewType)

Steamworks ISteamUGC::GetQueryUGCAdditionalPreview()

Declaration
Swift
public func getQueryUGCAdditionalPreview(
    handle: UGCQueryHandle, index: Int, previewIndex: Int,
    urlSize: Int = SteamConstants.filenameMaxSize,
    returnOriginalFileName: Bool = true,
    originalFileNameSize: Int = SteamConstants.filenameMaxSize
) -> (
    rc: Bool, urlOrVideoID: String, originalFileName: String,
    previewType: ItemPreviewType
)

func getQueryUGCChildren(handle: UGCQueryHandle, index: Int, maxEntries: Int) -> (rc: Bool, publishedFileID: PublishedFileID)

Steamworks ISteamUGC::GetQueryUGCChildren()

Declaration
Swift
public func getQueryUGCChildren(
    handle: UGCQueryHandle, index: Int, maxEntries: Int
) -> (rc: Bool, publishedFileID: PublishedFileID)

func getQueryUGCContentDescriptors(handle: UGCQueryHandle, index: Int, maxEntries: Int) -> (rc: Int, descriptors: [UGCContentDescriptorID])

Steamworks ISteamUGC::GetQueryUGCContentDescriptors()

Declaration
Swift
public func getQueryUGCContentDescriptors(
    handle: UGCQueryHandle, index: Int, maxEntries: Int
) -> (rc: Int, descriptors: [UGCContentDescriptorID])

func getQueryUGCKeyValueTag(handle: UGCQueryHandle, index: Int, valueTagIndex: Int, keySize: Int, valueSize: Int) -> (rc: Bool, key: String, value: String)

Steamworks ISteamUGC::GetQueryUGCKeyValueTag()

Declaration
Swift
public func getQueryUGCKeyValueTag(
    handle: UGCQueryHandle, index: Int, valueTagIndex: Int,
    keySize: Int = SteamConstants.ugcKeyValueMaxSize + 1,
    valueSize: Int = SteamConstants.ugcKeyValueMaxSize + 1
) -> (rc: Bool, key: String, value: String)

func getQueryUGCMetadata(handle: UGCQueryHandle, index: Int, metadatasizeSize: Int) -> (rc: Bool, metadata: String)

Steamworks ISteamUGC::GetQueryUGCMetadata()

Declaration
Swift
public func getQueryUGCMetadata(
    handle: UGCQueryHandle, index: Int, metadatasizeSize: Int
) -> (rc: Bool, metadata: String)

func getQueryUGCNumAdditionalPreviews(handle: UGCQueryHandle, index: Int) -> Int

Steamworks ISteamUGC::GetQueryUGCNumAdditionalPreviews()

Declaration
Swift
public func getQueryUGCNumAdditionalPreviews(handle: UGCQueryHandle, index: Int)
    -> Int

func getQueryUGCNumKeyValueTags(handle: UGCQueryHandle, index: Int) -> Int

Steamworks ISteamUGC::GetQueryUGCNumKeyValueTags()

Declaration
Swift
public func getQueryUGCNumKeyValueTags(handle: UGCQueryHandle, index: Int)
    -> Int

func getQueryUGCNumTags(handle: UGCQueryHandle, index: Int) -> Int

Steamworks ISteamUGC::GetQueryUGCNumTags()

Declaration
Swift
public func getQueryUGCNumTags(handle: UGCQueryHandle, index: Int) -> Int

func getQueryUGCPreviewURL(handle: UGCQueryHandle, index: Int, urlSize: Int) -> (rc: Bool, url: String)

Steamworks ISteamUGC::GetQueryUGCPreviewURL()

Declaration
Swift
public func getQueryUGCPreviewURL(
    handle: UGCQueryHandle, index: Int,
    urlSize: Int = SteamConstants.filenameMaxSize
) -> (rc: Bool, url: String)

func getQueryUGCResult(handle: UGCQueryHandle, index: Int) -> (rc: Bool, details: SteamUGCDetails)

Steamworks ISteamUGC::GetQueryUGCResult()

Declaration
Swift
public func getQueryUGCResult(handle: UGCQueryHandle, index: Int) -> (
    rc: Bool, details: SteamUGCDetails
)

func getQueryUGCStatistic(handle: UGCQueryHandle, index: Int, statType: ItemStatistic) -> (rc: Bool, statValue: UInt64)

Steamworks ISteamUGC::GetQueryUGCStatistic()

Declaration
Swift
public func getQueryUGCStatistic(
    handle: UGCQueryHandle, index: Int, statType: ItemStatistic
) -> (rc: Bool, statValue: UInt64)

func getQueryUGCTag(handle: UGCQueryHandle, index: Int, tag: Int, valueSize: Int) -> (rc: Bool, value: String)

Steamworks ISteamUGC::GetQueryUGCTag()

Declaration
Swift
public func getQueryUGCTag(
    handle: UGCQueryHandle, index: Int, tag: Int,
    valueSize: Int = SteamConstants.ugcKeyValueMaxSize + 1
) -> (rc: Bool, value: String)

func getQueryUGCTagDisplayName(handle: UGCQueryHandle, index: Int, tag: Int, valueSize: Int) -> (rc: Bool, value: String)

Steamworks ISteamUGC::GetQueryUGCTagDisplayName()

Declaration
Swift
public func getQueryUGCTagDisplayName(
    handle: UGCQueryHandle, index: Int, tag: Int,
    valueSize: Int = SteamConstants.ugcKeyValueMaxSize + 1
) -> (rc: Bool, value: String)

func getSubscribedItems(maxEntries: Int) -> (rc: Int, publishedFileID: [PublishedFileID])

Steamworks ISteamUGC::GetSubscribedItems()

Declaration
Swift
public func getSubscribedItems(maxEntries: Int) -> (
    rc: Int, publishedFileID: [PublishedFileID]
)

func getUserContentDescriptorPreferences(maxEntries: Int) -> (rc: Int, descriptors: [UGCContentDescriptorID])

Steamworks ISteamUGC::GetUserContentDescriptorPreferences()

Declaration
Swift
public func getUserContentDescriptorPreferences(maxEntries: Int) -> (
    rc: Int, descriptors: [UGCContentDescriptorID]
)

func getUserItemVote(publishedFileID: PublishedFileID, completion: (GetUserItemVoteResult?) -> Void)

Steamworks ISteamUGC::GetUserItemVote(), callback

Declaration
Swift
public func getUserItemVote(
    publishedFileID: PublishedFileID,
    completion: @escaping (GetUserItemVoteResult?) -> Void)

func getUserItemVote(publishedFileID: PublishedFileID) async -> GetUserItemVoteResult?

Steamworks ISteamUGC::GetUserItemVote(), async

Declaration
Swift
public func getUserItemVote(publishedFileID: PublishedFileID) async
    -> GetUserItemVoteResult?

func getWorkshopEULAStatus(completion: (WorkshopEULAStatus?) -> Void)

Steamworks ISteamUGC::GetWorkshopEULAStatus(), callback

Declaration
Swift
public func getWorkshopEULAStatus(
    completion: @escaping (WorkshopEULAStatus?) -> Void)

func getWorkshopEULAStatus() async -> WorkshopEULAStatus?

Steamworks ISteamUGC::GetWorkshopEULAStatus(), async

Declaration
Swift
public func getWorkshopEULAStatus() async -> WorkshopEULAStatus?

func releaseQueryUGCRequest(handle: UGCQueryHandle) -> Bool

Steamworks ISteamUGC::ReleaseQueryUGCRequest()

Declaration
Swift
@discardableResult
public func releaseQueryUGCRequest(handle: UGCQueryHandle) -> Bool

func removeAllItemKeyValueTags(handle: UGCUpdateHandle) -> Bool

Steamworks ISteamUGC::RemoveAllItemKeyValueTags()

Declaration
Swift
public func removeAllItemKeyValueTags(handle: UGCUpdateHandle) -> Bool

func removeAppDependency(publishedFileID: PublishedFileID, appID: AppID, completion: (RemoveAppDependencyResult?) -> Void)

Steamworks ISteamUGC::RemoveAppDependency(), callback

Declaration
Swift
public func removeAppDependency(
    publishedFileID: PublishedFileID, appID: AppID,
    completion: @escaping (RemoveAppDependencyResult?) -> Void)

func removeAppDependency(publishedFileID: PublishedFileID, appID: AppID) async -> RemoveAppDependencyResult?

Steamworks ISteamUGC::RemoveAppDependency(), async

Declaration
Swift
public func removeAppDependency(publishedFileID: PublishedFileID, appID: AppID)
    async -> RemoveAppDependencyResult?

func removeContentDescriptor(handle: UGCUpdateHandle, descid: UGCContentDescriptorID) -> Bool

Steamworks ISteamUGC::RemoveContentDescriptor()

Declaration
Swift
public func removeContentDescriptor(
    handle: UGCUpdateHandle, descid: UGCContentDescriptorID
) -> Bool

func removeDependency(parentPublishedFileID: PublishedFileID, childPublishedFileID: PublishedFileID, completion: (RemoveUGCDependencyResult?) -> Void)

Steamworks ISteamUGC::RemoveDependency(), callback

Declaration
Swift
public func removeDependency(
    parentPublishedFileID: PublishedFileID,
    childPublishedFileID: PublishedFileID,
    completion: @escaping (RemoveUGCDependencyResult?) -> Void)

func removeDependency(parentPublishedFileID: PublishedFileID, childPublishedFileID: PublishedFileID) async -> RemoveUGCDependencyResult?

Steamworks ISteamUGC::RemoveDependency(), async

Declaration
Swift
public func removeDependency(
    parentPublishedFileID: PublishedFileID,
    childPublishedFileID: PublishedFileID
) async -> RemoveUGCDependencyResult?

func removeItemFromFavorites(appId: AppID, publishedFileID: PublishedFileID, completion: (UserFavoriteItemsListChanged?) -> Void)

Steamworks ISteamUGC::RemoveItemFromFavorites(), callback

Declaration
Swift
public func removeItemFromFavorites(
    appId: AppID, publishedFileID: PublishedFileID,
    completion: @escaping (UserFavoriteItemsListChanged?) -> Void)

func removeItemFromFavorites(appId: AppID, publishedFileID: PublishedFileID) async -> UserFavoriteItemsListChanged?

Steamworks ISteamUGC::RemoveItemFromFavorites(), async

Declaration
Swift
public func removeItemFromFavorites(
    appId: AppID, publishedFileID: PublishedFileID
) async -> UserFavoriteItemsListChanged?

func removeItemKeyValueTags(handle: UGCUpdateHandle, key: String) -> Bool

Steamworks ISteamUGC::RemoveItemKeyValueTags()

Declaration
Swift
@discardableResult
public func removeItemKeyValueTags(handle: UGCUpdateHandle, key: String) -> Bool

func removeItemPreview(handle: UGCUpdateHandle, index: Int) -> Bool

Steamworks ISteamUGC::RemoveItemPreview()

Declaration
Swift
@discardableResult
public func removeItemPreview(handle: UGCUpdateHandle, index: Int) -> Bool

func requestUGCDetails(publishedFileID: PublishedFileID, maxAgeSeconds: Int, completion: (SteamUGCRequestUGCDetailsResult?) -> Void)

Steamworks ISteamUGC::RequestUGCDetails(), callback

Declaration
Swift
public func requestUGCDetails(
    publishedFileID: PublishedFileID, maxAgeSeconds: Int,
    completion: @escaping (SteamUGCRequestUGCDetailsResult?) -> Void)

func requestUGCDetails(publishedFileID: PublishedFileID, maxAgeSeconds: Int) async -> SteamUGCRequestUGCDetailsResult?

Steamworks ISteamUGC::RequestUGCDetails(), async

Declaration
Swift
public func requestUGCDetails(
    publishedFileID: PublishedFileID, maxAgeSeconds: Int
) async -> SteamUGCRequestUGCDetailsResult?

func sendQueryUGCRequest(handle: UGCQueryHandle, completion: (SteamUGCQueryCompleted?) -> Void)

Steamworks ISteamUGC::SendQueryUGCRequest(), callback

Declaration
Swift
public func sendQueryUGCRequest(
    handle: UGCQueryHandle,
    completion: @escaping (SteamUGCQueryCompleted?) -> Void)

func sendQueryUGCRequest(handle: UGCQueryHandle) async -> SteamUGCQueryCompleted?

Steamworks ISteamUGC::SendQueryUGCRequest(), async

Declaration
Swift
public func sendQueryUGCRequest(handle: UGCQueryHandle) async
    -> SteamUGCQueryCompleted?

func setAllowCachedResponse(handle: UGCQueryHandle, maxAgeSeconds: Int) -> Bool

Steamworks ISteamUGC::SetAllowCachedResponse()

Declaration
Swift
@discardableResult
public func setAllowCachedResponse(handle: UGCQueryHandle, maxAgeSeconds: Int)
    -> Bool

func setAllowLegacyUpload(handle: UGCUpdateHandle, allowLegacyUpload: Bool) -> Bool

Steamworks ISteamUGC::SetAllowLegacyUpload()

Declaration
Swift
public func setAllowLegacyUpload(
    handle: UGCUpdateHandle, allowLegacyUpload: Bool
) -> Bool

func setCloudFileNameFilter(handle: UGCQueryHandle, matchCloudFileName: String) -> Bool

Steamworks ISteamUGC::SetCloudFileNameFilter()

Declaration
Swift
@discardableResult
public func setCloudFileNameFilter(
    handle: UGCQueryHandle, matchCloudFileName: String
) -> Bool

func setItemContent(handle: UGCUpdateHandle, contentFolder: String) -> Bool

Steamworks ISteamUGC::SetItemContent()

Declaration
Swift
@discardableResult
public func setItemContent(handle: UGCUpdateHandle, contentFolder: String)
    -> Bool

func setItemDescription(handle: UGCUpdateHandle, description: String) -> Bool

Steamworks ISteamUGC::SetItemDescription()

Declaration
Swift
@discardableResult
public func setItemDescription(handle: UGCUpdateHandle, description: String)
    -> Bool

func setItemMetadata(handle: UGCUpdateHandle, metaData: String) -> Bool

Steamworks ISteamUGC::SetItemMetadata()

Declaration
Swift
@discardableResult
public func setItemMetadata(handle: UGCUpdateHandle, metaData: String) -> Bool

func setItemPreview(handle: UGCUpdateHandle, previewFile: String) -> Bool

Steamworks ISteamUGC::SetItemPreview()

Declaration
Swift
@discardableResult
public func setItemPreview(handle: UGCUpdateHandle, previewFile: String) -> Bool

func setItemTags(handle: UGCUpdateHandle, tags: [String], allowAdminTags: Bool) -> Bool

Steamworks ISteamUGC::SetItemTags()

Declaration
Swift
@discardableResult
public func setItemTags(
    handle: UGCUpdateHandle, tags: [String], allowAdminTags: Bool = false
) -> Bool

func setItemTitle(handle: UGCUpdateHandle, title: String) -> Bool

Steamworks ISteamUGC::SetItemTitle()

Declaration
Swift
@discardableResult
public func setItemTitle(handle: UGCUpdateHandle, title: String) -> Bool

func setItemUpdateLanguage(handle: UGCUpdateHandle, language: String) -> Bool

Steamworks ISteamUGC::SetItemUpdateLanguage()

Declaration
Swift
@discardableResult
public func setItemUpdateLanguage(handle: UGCUpdateHandle, language: String)
    -> Bool

func setItemVisibility(handle: UGCUpdateHandle, visibility: RemoteStoragePublishedFileVisibility) -> Bool

Steamworks ISteamUGC::SetItemVisibility()

Declaration
Swift
@discardableResult
public func setItemVisibility(
    handle: UGCUpdateHandle, visibility: RemoteStoragePublishedFileVisibility
) -> Bool

func setLanguage(handle: UGCQueryHandle, language: String) -> Bool

Steamworks ISteamUGC::SetLanguage()

Declaration
Swift
@discardableResult
public func setLanguage(handle: UGCQueryHandle, language: String) -> Bool

func setMatchAnyTag(handle: UGCQueryHandle, matchAnyTag: Bool) -> Bool

Steamworks ISteamUGC::SetMatchAnyTag()

Declaration
Swift
@discardableResult
public func setMatchAnyTag(handle: UGCQueryHandle, matchAnyTag: Bool) -> Bool

func setRankedByTrendDays(handle: UGCQueryHandle, days: Int) -> Bool

Steamworks ISteamUGC::SetRankedByTrendDays()

Declaration
Swift
@discardableResult
public func setRankedByTrendDays(handle: UGCQueryHandle, days: Int) -> Bool

func setReturnAdditionalPreviews(handle: UGCQueryHandle, returnAdditionalPreviews: Bool) -> Bool

Steamworks ISteamUGC::SetReturnAdditionalPreviews()

Declaration
Swift
@discardableResult
public func setReturnAdditionalPreviews(
    handle: UGCQueryHandle, returnAdditionalPreviews: Bool
) -> Bool

func setReturnChildren(handle: UGCQueryHandle, returnChildren: Bool) -> Bool

Steamworks ISteamUGC::SetReturnChildren()

Declaration
Swift
@discardableResult
public func setReturnChildren(handle: UGCQueryHandle, returnChildren: Bool)
    -> Bool

func setReturnKeyValueTags(handle: UGCQueryHandle, returnKeyValueTags: Bool) -> Bool

Steamworks ISteamUGC::SetReturnKeyValueTags()

Declaration
Swift
@discardableResult
public func setReturnKeyValueTags(
    handle: UGCQueryHandle, returnKeyValueTags: Bool
) -> Bool

func setReturnLongDescription(handle: UGCQueryHandle, returnLongDescription: Bool) -> Bool

Steamworks ISteamUGC::SetReturnLongDescription()

Declaration
Swift
@discardableResult
public func setReturnLongDescription(
    handle: UGCQueryHandle, returnLongDescription: Bool
) -> Bool

func setReturnMetadata(handle: UGCQueryHandle, returnMetadata: Bool) -> Bool

Steamworks ISteamUGC::SetReturnMetadata()

Declaration
Swift
@discardableResult
public func setReturnMetadata(handle: UGCQueryHandle, returnMetadata: Bool)
    -> Bool

func setReturnOnlyIDs(handle: UGCQueryHandle, returnOnlyIDs: Bool) -> Bool

Steamworks ISteamUGC::SetReturnOnlyIDs()

Declaration
Swift
@discardableResult
public func setReturnOnlyIDs(handle: UGCQueryHandle, returnOnlyIDs: Bool)
    -> Bool

func setReturnPlaytimeStats(handle: UGCQueryHandle, days: Int) -> Bool

Steamworks ISteamUGC::SetReturnPlaytimeStats()

Declaration
Swift
@discardableResult
public func setReturnPlaytimeStats(handle: UGCQueryHandle, days: Int) -> Bool

func setReturnTotalOnly(handle: UGCQueryHandle, returnTotalOnly: Bool) -> Bool

Steamworks ISteamUGC::SetReturnTotalOnly()

Declaration
Swift
@discardableResult
public func setReturnTotalOnly(handle: UGCQueryHandle, returnTotalOnly: Bool)
    -> Bool

func setSearchText(handle: UGCQueryHandle, searchText: String) -> Bool

Steamworks ISteamUGC::SetSearchText()

Declaration
Swift
@discardableResult
public func setSearchText(handle: UGCQueryHandle, searchText: String) -> Bool

func setTimeCreatedDateRange(handle: UGCQueryHandle, start: RTime32, end: RTime32) -> Bool

Steamworks ISteamUGC::SetTimeCreatedDateRange()

Declaration
Swift
public func setTimeCreatedDateRange(
    handle: UGCQueryHandle, start: RTime32, end: RTime32
) -> Bool

func setTimeUpdatedDateRange(handle: UGCQueryHandle, start: RTime32, end: RTime32) -> Bool

Steamworks ISteamUGC::SetTimeUpdatedDateRange()

Declaration
Swift
public func setTimeUpdatedDateRange(
    handle: UGCQueryHandle, start: RTime32, end: RTime32
) -> Bool

func setUserItemVote(publishedFileID: PublishedFileID, voteUp: Bool, completion: (SetUserItemVoteResult?) -> Void)

Steamworks ISteamUGC::SetUserItemVote(), callback

Declaration
Swift
public func setUserItemVote(
    publishedFileID: PublishedFileID, voteUp: Bool,
    completion: @escaping (SetUserItemVoteResult?) -> Void)

func setUserItemVote(publishedFileID: PublishedFileID, voteUp: Bool) async -> SetUserItemVoteResult?

Steamworks ISteamUGC::SetUserItemVote(), async

Declaration
Swift
public func setUserItemVote(publishedFileID: PublishedFileID, voteUp: Bool)
    async -> SetUserItemVoteResult?

func showWorkshopEULA() -> Bool

Steamworks ISteamUGC::ShowWorkshopEULA()

Declaration
Swift
public func showWorkshopEULA() -> Bool

func startItemUpdate(consumerAppId: AppID, publishedFileID: PublishedFileID) -> UGCUpdateHandle

Steamworks ISteamUGC::StartItemUpdate()

Declaration
Swift
public func startItemUpdate(
    consumerAppId: AppID, publishedFileID: PublishedFileID
) -> UGCUpdateHandle

func startPlaytimeTracking(publishedFileID: [PublishedFileID], completion: (StartPlaytimeTrackingResult?) -> Void)

Steamworks ISteamUGC::StartPlaytimeTracking(), callback

Declaration
Swift
public func startPlaytimeTracking(
    publishedFileID: [PublishedFileID],
    completion: @escaping (StartPlaytimeTrackingResult?) -> Void)

func startPlaytimeTracking(publishedFileID: [PublishedFileID]) async -> StartPlaytimeTrackingResult?

Steamworks ISteamUGC::StartPlaytimeTracking(), async

Declaration
Swift
public func startPlaytimeTracking(publishedFileID: [PublishedFileID]) async
    -> StartPlaytimeTrackingResult?

func stopPlaytimeTracking(publishedFileID: [PublishedFileID], completion: (StopPlaytimeTrackingResult?) -> Void)

Steamworks ISteamUGC::StopPlaytimeTracking(), callback

Declaration
Swift
public func stopPlaytimeTracking(
    publishedFileID: [PublishedFileID],
    completion: @escaping (StopPlaytimeTrackingResult?) -> Void)

func stopPlaytimeTracking(publishedFileID: [PublishedFileID]) async -> StopPlaytimeTrackingResult?

Steamworks ISteamUGC::StopPlaytimeTracking(), async

Declaration
Swift
public func stopPlaytimeTracking(publishedFileID: [PublishedFileID]) async
    -> StopPlaytimeTrackingResult?

func stopPlaytimeTrackingForAllItems(completion: (StopPlaytimeTrackingResult?) -> Void)

Steamworks ISteamUGC::StopPlaytimeTrackingForAllItems(), callback

Declaration
Swift
public func stopPlaytimeTrackingForAllItems(
    completion: @escaping (StopPlaytimeTrackingResult?) -> Void)

func stopPlaytimeTrackingForAllItems() async -> StopPlaytimeTrackingResult?

Steamworks ISteamUGC::StopPlaytimeTrackingForAllItems(), async

Declaration
Swift
public func stopPlaytimeTrackingForAllItems() async
    -> StopPlaytimeTrackingResult?

func submitItemUpdate(handle: UGCUpdateHandle, changeNote: String?, completion: (SubmitItemUpdateResult?) -> Void)

Steamworks ISteamUGC::SubmitItemUpdate(), callback

Declaration
Swift
public func submitItemUpdate(
    handle: UGCUpdateHandle, changeNote: String?,
    completion: @escaping (SubmitItemUpdateResult?) -> Void)

func submitItemUpdate(handle: UGCUpdateHandle, changeNote: String?) async -> SubmitItemUpdateResult?

Steamworks ISteamUGC::SubmitItemUpdate(), async

Declaration
Swift
public func submitItemUpdate(handle: UGCUpdateHandle, changeNote: String?) async
    -> SubmitItemUpdateResult?

func subscribeItem(publishedFileID: PublishedFileID, completion: (RemoteStorageSubscribePublishedFileResult?) -> Void)

Steamworks ISteamUGC::SubscribeItem(), callback

Declaration
Swift
public func subscribeItem(
    publishedFileID: PublishedFileID,
    completion: @escaping (RemoteStorageSubscribePublishedFileResult?) -> Void)

func subscribeItem(publishedFileID: PublishedFileID) async -> RemoteStorageSubscribePublishedFileResult?

Steamworks ISteamUGC::SubscribeItem(), async

Declaration
Swift
public func subscribeItem(publishedFileID: PublishedFileID) async
    -> RemoteStorageSubscribePublishedFileResult?

func suspendDownloads(suspend: Bool)

Steamworks ISteamUGC::SuspendDownloads()

Declaration
Swift
public func suspendDownloads(suspend: Bool)

func unsubscribeItem(publishedFileID: PublishedFileID, completion: (RemoteStorageUnsubscribePublishedFileResult?) -> Void)

Steamworks ISteamUGC::UnsubscribeItem(), callback

Declaration
Swift
public func unsubscribeItem(
    publishedFileID: PublishedFileID,
    completion: @escaping (RemoteStorageUnsubscribePublishedFileResult?) -> Void
)

func unsubscribeItem(publishedFileID: PublishedFileID) async -> RemoteStorageUnsubscribePublishedFileResult?

Steamworks ISteamUGC::UnsubscribeItem(), async

Declaration
Swift
public func unsubscribeItem(publishedFileID: PublishedFileID) async
    -> RemoteStorageUnsubscribePublishedFileResult?

func updateItemPreviewFile(handle: UGCUpdateHandle, index: Int, previewFile: String) -> Bool

Steamworks ISteamUGC::UpdateItemPreviewFile()

Declaration
Swift
@discardableResult
public func updateItemPreviewFile(
    handle: UGCUpdateHandle, index: Int, previewFile: String
) -> Bool

func updateItemPreviewVideo(handle: UGCUpdateHandle, index: Int, videoID: String) -> Bool

Steamworks ISteamUGC::UpdateItemPreviewVideo()

Declaration
Swift
@discardableResult
public func updateItemPreviewVideo(
    handle: UGCUpdateHandle, index: Int, videoID: String
) -> Bool

func getSubscribedItems() -> (rc: Int, publishedFileID: [PublishedFileID])

Note

Provided by module SteamworksHelpers.

Steamworks ISteamUGC::GetSubscribedItems()

Declaration
Swift
public func getSubscribedItems() -> (
    rc: Int, publishedFileID: [PublishedFileID]
)