ISteamUGC::SuspendDownloads:暂停或恢复工坊下载
SuspendDownloads 用于控制当前应用的工坊下载暂停状态,适合需要暂时稳定磁盘内容的场景。本页面向 Steamworks 游戏和工具开发者,说明接口声明、参数、返回方式以及与工坊内容生命周期相关的注意事项。
函数声明
客户端通过初始化成功后的 SteamUGC() 接口访问;游戏服务器使用服务器上下文的 SteamGameServerUGC()。以下声明按本次核对的官方接口整理,编译时应以项目实际使用的 SDK 头文件为准。
void SuspendDownloads( bool bSuspend );
参数
| 参数 | 类型 | 方向与含义 |
|---|---|---|
bSuspend |
bool |
输入:true 暂停下载,false 恢复下载。 |
返回值与完成方式
返回类型为 void;此调用没有同步成功标志,也没有在此方法中返回下载完成结果。
该调用没有直接返回值;游戏应通过与该流程对应的状态查询或通知来决定下一步。
调用规则与排查
bSuspend 为 true 时暂停,为 false 时恢复;暂停会持续到恢复调用或游戏结束。应明确管理暂停和恢复的配对时机,避免在游戏运行期间意外长期阻塞下载。下载完成与否仍应结合项目状态和相关回调判断。
使用场景
例如,游戏在某段操作期间需要避免工坊文件发生变化,可以进入该阶段时暂停下载,结束后明确恢复。退出该阶段的错误路径也应执行恢复逻辑。暂停只控制下载,不应被当作已完成安装的信号;恢复后仍需检查具体项目状态。
相关接口
DownloadItem、GetItemState。回调、状态与类型参考整理了相关结构体和枚举,适合在处理结果时对照使用。
资料依据:Steamworks ISteamUGC:SuspendDownloads。资料核对日期:2026 年 11 月 4 日。