ISteamUGC::UnsubscribeItem:取消订阅工坊项目

ISteamUGC::UnsubscribeItem:取消订阅工坊项目

UnsubscribeItem 用于让当前用户取消对指定工坊项目的订阅,适合游戏内的内容管理界面。本页面向 Steamworks 游戏和工具开发者,说明接口声明、参数、返回方式以及与工坊内容生命周期相关的注意事项。

工坊内容获取与加载流程

函数声明

客户端通过初始化成功后的 SteamUGC() 接口访问;游戏服务器使用服务器上下文的 SteamGameServerUGC()。以下声明按本次核对的官方接口整理,编译时应以项目实际使用的 SDK 头文件为准。

SteamAPICall_t UnsubscribeItem( PublishedFileId_t nPublishedFileID );

参数

参数 类型 方向与含义
nPublishedFileID PublishedFileId_t 输入:目标工坊项目的 PublishedFileId_t。

返回值与完成方式

返回 SteamAPICall_t;使用 RemoteStorageUnsubscribePublishedFileResult_t 检查结果和项目 ID。

调用结果由 Steam 异步交付。应在对象有效期间保存对应的结果处理器,并持续运行 Steam 回调;还要区分传输失败与结果结构中的操作失败。

调用规则与排查

取消订阅后,项目通常在游戏退出时移除,不应假定正在运行的进程立刻看不到文件。若内容已被加载,应先按游戏自己的资源生命周期卸载,再更新显示;外部订阅变化也可通过相应通知处理。

使用场景

例如,玩家在管理界面移除一个 Mod 时,游戏可以发起取消订阅并等待对应结果。结果成功后更新列表;若该 Mod 当前仍被游戏使用,按照自己的资源生命周期安全卸载或提示重新启动。文件在退出游戏后移除的安排与界面的立即更新应分开处理。

相关接口

SubscribeItem、GetSubscribedItems。回调、状态与类型参考整理了相关结构体和枚举,适合在处理结果时对照使用。

站内字段参考

RemoteStorageUnsubscribePublishedFileResult_t。

资料依据:Steamworks ISteamUGC:UnsubscribeItem。资料核对日期:2026 年 11 月 4 日。