Steamworks v1.1.0
Open on GitHub Open in Dash

SteamUGC

Swift
public struct SteamUGC: Sendable

Steamworks ISteamUGC

Access via ugc through a SteamAPI or SteamGameServerAPI instance.

Topics

Steamworks ISteamUGC::AddAppDependency(), callback

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

Steamworks ISteamUGC::AddAppDependency(), async

Declaration
Swift
public func addAppDependency(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID, appID: AppID
) async -> AddAppDependencyResult?

Steamworks ISteamUGC::AddContentDescriptor()

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

Steamworks ISteamUGC::AddDependency(), callback

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

Steamworks ISteamUGC::AddDependency(), async

Declaration
Swift
public func addDependency(
    isolation: isolated (any Actor)? = #isolation,
    parentPublishedFileID: PublishedFileID,
    childPublishedFileID: PublishedFileID
) async -> AddUGCDependencyResult?

Steamworks ISteamUGC::AddExcludedTag()

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

Steamworks ISteamUGC::AddItemKeyValueTag()

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

Steamworks ISteamUGC::AddItemPreviewFile()

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

Steamworks ISteamUGC::AddItemPreviewVideo()

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

Steamworks ISteamUGC::AddItemToFavorites(), callback

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

Steamworks ISteamUGC::AddItemToFavorites(), async

Declaration
Swift
public func addItemToFavorites(
    isolation: isolated (any Actor)? = #isolation, appId: AppID,
    publishedFileID: PublishedFileID
) async -> UserFavoriteItemsListChanged?

Steamworks ISteamUGC::AddRequiredKeyValueTag()

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

Steamworks ISteamUGC::AddRequiredTag()

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

Steamworks ISteamUGC::AddRequiredTagGroup()

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

Steamworks ISteamUGC::BInitWorkshopForGameServer()

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

Steamworks ISteamUGC::CreateItem(), callback

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

Steamworks ISteamUGC::CreateItem(), async

Declaration
Swift
public func createItem(
    isolation: isolated (any Actor)? = #isolation, consumerAppId: AppID,
    fileType: WorkshopFileType
) async -> CreateItemResult?

Steamworks ISteamUGC::CreateQueryAllUGCRequest()

Declaration
Swift
public 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, page: Int
) -> UGCQueryHandle

Steamworks ISteamUGC::CreateQueryUGCDetailsRequest()

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

Steamworks ISteamUGC::CreateQueryUserUGCRequest()

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

Steamworks ISteamUGC::DeleteItem(), callback

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

Steamworks ISteamUGC::DeleteItem(), async

Declaration
Swift
public func deleteItem(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID
) async -> DeleteItemResult?

Steamworks ISteamUGC::DownloadItem()

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

Steamworks ISteamUGC::GetAppDependencies(), callback

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

Steamworks ISteamUGC::GetAppDependencies(), async

Declaration
Swift
public func getAppDependencies(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID
) async -> GetAppDependenciesResult?

Steamworks ISteamUGC::GetItemDownloadInfo()

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

Steamworks ISteamUGC::GetItemInstallInfo()

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

Steamworks ISteamUGC::GetItemState()

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

Steamworks ISteamUGC::GetItemUpdateProgress()

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

Steamworks ISteamUGC::GetNumSubscribedItems()

Declaration
Swift
public func getNumSubscribedItems() -> Int

Steamworks ISteamUGC::GetNumSupportedGameVersions()

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

Steamworks ISteamUGC::GetQueryUGCKeyValueTag()

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

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
)

Steamworks ISteamUGC::GetQueryUGCChildren()

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

Steamworks ISteamUGC::GetQueryUGCContentDescriptors()

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

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)

Steamworks ISteamUGC::GetQueryUGCMetadata()

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

Steamworks ISteamUGC::GetQueryUGCNumAdditionalPreviews()

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

Steamworks ISteamUGC::GetQueryUGCNumKeyValueTags()

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

Steamworks ISteamUGC::GetQueryUGCNumTags()

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

Steamworks ISteamUGC::GetQueryUGCPreviewURL()

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

Steamworks ISteamUGC::GetQueryUGCResult()

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

Steamworks ISteamUGC::GetQueryUGCStatistic()

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

Steamworks ISteamUGC::GetQueryUGCTag()

Declaration
Swift
public func getQueryUGCTag(
    handle: UGCQueryHandle, index: Int, tag: Int,
    valueSize: Int = SteamConstants.ugcKeyValueMaxSize + 1
) -> (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)

Steamworks ISteamUGC::GetSubscribedItems()

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

Steamworks ISteamUGC::GetSupportedGameVersionData()

Declaration
Swift
public func getSupportedGameVersionData(
    handle: UGCQueryHandle, index: Int, versionIndex: Int, gameBranchSize: Int
) -> (rc: Bool, gameBranchMin: String, gameBranchMax: String)

Steamworks ISteamUGC::GetUserContentDescriptorPreferences()

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

Steamworks ISteamUGC::GetUserItemVote(), callback

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

Steamworks ISteamUGC::GetUserItemVote(), async

Declaration
Swift
public func getUserItemVote(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID
) async -> GetUserItemVoteResult?

Steamworks ISteamUGC::GetWorkshopEULAStatus(), callback

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

Steamworks ISteamUGC::GetWorkshopEULAStatus(), async

Declaration
Swift
public func getWorkshopEULAStatus(isolation: isolated (any Actor)? = #isolation)
    async -> WorkshopEULAStatus?

Steamworks ISteamUGC::ReleaseQueryUGCRequest()

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

Steamworks ISteamUGC::RemoveAllItemKeyValueTags()

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

Steamworks ISteamUGC::RemoveAppDependency(), callback

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

Steamworks ISteamUGC::RemoveAppDependency(), async

Declaration
Swift
public func removeAppDependency(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID, appID: AppID
) async -> RemoveAppDependencyResult?

Steamworks ISteamUGC::RemoveContentDescriptor()

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

Steamworks ISteamUGC::RemoveDependency(), callback

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

Steamworks ISteamUGC::RemoveDependency(), async

Declaration
Swift
public func removeDependency(
    isolation: isolated (any Actor)? = #isolation,
    parentPublishedFileID: PublishedFileID,
    childPublishedFileID: PublishedFileID
) async -> RemoveUGCDependencyResult?

Steamworks ISteamUGC::RemoveItemFromFavorites(), callback

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

Steamworks ISteamUGC::RemoveItemFromFavorites(), async

Declaration
Swift
public func removeItemFromFavorites(
    isolation: isolated (any Actor)? = #isolation, appId: AppID,
    publishedFileID: PublishedFileID
) async -> UserFavoriteItemsListChanged?

Steamworks ISteamUGC::RemoveItemKeyValueTags()

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

Steamworks ISteamUGC::RemoveItemPreview()

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

Steamworks ISteamUGC::RequestUGCDetails(), callback

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

Steamworks ISteamUGC::RequestUGCDetails(), async

Declaration
Swift
public func requestUGCDetails(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID, maxAgeSeconds: Int
) async -> SteamUGCRequestUGCDetailsResult?

Steamworks ISteamUGC::SendQueryUGCRequest(), callback

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

Steamworks ISteamUGC::SendQueryUGCRequest(), async

Declaration
Swift
public func sendQueryUGCRequest(
    isolation: isolated (any Actor)? = #isolation, handle: UGCQueryHandle
) async -> SteamUGCQueryCompleted?

Steamworks ISteamUGC::SetAdminQuery()

Declaration
Swift
public func setAdminQuery(handle: UGCUpdateHandle, adminQuery: Bool) -> Bool

Steamworks ISteamUGC::SetAllowCachedResponse()

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

Steamworks ISteamUGC::SetAllowLegacyUpload()

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

Steamworks ISteamUGC::SetCloudFileNameFilter()

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

Steamworks ISteamUGC::SetItemContent()

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

Steamworks ISteamUGC::SetItemDescription()

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

Steamworks ISteamUGC::SetItemMetadata()

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

Steamworks ISteamUGC::SetItemPreview()

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

Steamworks ISteamUGC::SetItemTags()

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

Steamworks ISteamUGC::SetItemTitle()

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

Steamworks ISteamUGC::SetItemUpdateLanguage()

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

Steamworks ISteamUGC::SetItemVisibility()

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

Steamworks ISteamUGC::SetLanguage()

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

Steamworks ISteamUGC::SetMatchAnyTag()

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

Steamworks ISteamUGC::SetRankedByTrendDays()

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

Steamworks ISteamUGC::SetRequiredGameVersions()

Declaration
Swift
public func setRequiredGameVersions(
    handle: UGCUpdateHandle, gameBranchMin: String, gameBranchMax: String
) -> Bool

Steamworks ISteamUGC::SetReturnAdditionalPreviews()

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

Steamworks ISteamUGC::SetReturnChildren()

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

Steamworks ISteamUGC::SetReturnKeyValueTags()

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

Steamworks ISteamUGC::SetReturnLongDescription()

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

Steamworks ISteamUGC::SetReturnMetadata()

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

Steamworks ISteamUGC::SetReturnOnlyIDs()

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

Steamworks ISteamUGC::SetReturnPlaytimeStats()

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

Steamworks ISteamUGC::SetReturnTotalOnly()

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

Steamworks ISteamUGC::SetSearchText()

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

Steamworks ISteamUGC::SetTimeCreatedDateRange()

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

Steamworks ISteamUGC::SetTimeUpdatedDateRange()

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

Steamworks ISteamUGC::SetUserItemVote(), callback

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

Steamworks ISteamUGC::SetUserItemVote(), async

Declaration
Swift
public func setUserItemVote(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID, voteUp: Bool
) async -> SetUserItemVoteResult?

Steamworks ISteamUGC::ShowWorkshopEULA()

Declaration
Swift
public func showWorkshopEULA() -> Bool

Steamworks ISteamUGC::StartItemUpdate()

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

Steamworks ISteamUGC::StartPlaytimeTracking(), callback

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

Steamworks ISteamUGC::StartPlaytimeTracking(), async

Declaration
Swift
public func startPlaytimeTracking(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: [PublishedFileID]
) async -> StartPlaytimeTrackingResult?

Steamworks ISteamUGC::StopPlaytimeTracking(), callback

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

Steamworks ISteamUGC::StopPlaytimeTracking(), async

Declaration
Swift
public func stopPlaytimeTracking(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: [PublishedFileID]
) async -> StopPlaytimeTrackingResult?

Steamworks ISteamUGC::StopPlaytimeTrackingForAllItems(), callback

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

Steamworks ISteamUGC::StopPlaytimeTrackingForAllItems(), async

Declaration
Swift
public func stopPlaytimeTrackingForAllItems(
    isolation: isolated (any Actor)? = #isolation
) async -> StopPlaytimeTrackingResult?

Steamworks ISteamUGC::SubmitItemUpdate(), callback

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

Steamworks ISteamUGC::SubmitItemUpdate(), async

Declaration
Swift
public func submitItemUpdate(
    isolation: isolated (any Actor)? = #isolation, handle: UGCUpdateHandle,
    changeNote: String?
) async -> SubmitItemUpdateResult?

Steamworks ISteamUGC::SubscribeItem(), callback

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

Steamworks ISteamUGC::SubscribeItem(), async

Declaration
Swift
public func subscribeItem(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID
) async -> RemoteStorageSubscribePublishedFileResult?

Steamworks ISteamUGC::SuspendDownloads()

Declaration
Swift
public func suspendDownloads(suspend: Bool)

Steamworks ISteamUGC::UnsubscribeItem(), callback

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

Steamworks ISteamUGC::UnsubscribeItem(), async

Declaration
Swift
public func unsubscribeItem(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileID: PublishedFileID
) async -> RemoteStorageUnsubscribePublishedFileResult?

Steamworks ISteamUGC::UpdateItemPreviewFile()

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

Steamworks ISteamUGC::UpdateItemPreviewVideo()

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

Provided by module SteamworksHelpers.

Steamworks ISteamUGC::GetSubscribedItems()

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