ISteamUGC::GetNumSubscribedItems:获取订阅项目数量
GetNumSubscribedItems 用于统计当前用户在运行中应用所订阅的工坊项目,为后续获取 ID 数组提供容量参考。本页面向 Steamworks 游戏和工具开发者,说明接口声明、参数、返回方式以及与工坊内容生命周期相关的注意事项。
函数声明
客户端通过初始化成功后的 SteamUGC() 接口访问;游戏服务器使用服务器上下文的 SteamGameServerUGC()。以下声明按本次核对的官方接口整理,编译时应以项目实际使用的 SDK 头文件为准。
uint32 GetNumSubscribedItems( bool bIncludeLocallyDisabled = false );
参数
| 参数 | 类型 | 方向与含义 |
|---|---|---|
bIncludeLocallyDisabled |
bool |
输入:是否包含本地禁用项目;默认 false。 |
返回值与完成方式
返回 uint32 数量;从游戏服务器调用时返回 0。默认不计入已在本地禁用的项目。
读取返回值后,应按其实际含义处理计数或位标志;涉及输出数组时只遍历实际写入的元素,不要把缓冲区容量误当作结果数量。
调用规则与排查
如果界面需要展示已禁用项,将 bIncludeLocallyDisabled 设为 true,并在 GetSubscribedItems 中使用相同选项。计数后订阅可能发生变化,填充数组时应使用实际返回数量,而不是假设数量永远不变。
使用场景
例如,玩家打开 Mod 管理界面时,游戏先选择是否展示本地禁用项,再取得数量,为 ID 数组准备容量。随后用相同选项调用列表接口,按照实际写入数量生成界面。若订阅在两次调用之间变化,应用可以重新获取一次以反映最新情况。
相关接口
GetSubscribedItems、SetItemsDisabledLocally。回调、状态与类型参考整理了相关结构体和枚举,适合在处理结果时对照使用。
资料依据:Steamworks ISteamUGC:GetNumSubscribedItems。资料核对日期:2026 年 11 月 4 日。