库是您可以用来操作内置数据类型的函数组。

Roblox 引擎库

体验

虚拟形象

素材

范例和项目

引擎 API

Open Cloud API

Studio

分析

平台

教程

创作者计划

教育

学习

此方法是异步的，会返回一个`Operation`对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅[文档]({longRunningOperationsLink})。

以下部分描述了操作完成时提供的响应和元数据对象。

Beta 测试终点已准备好公开使用。可能出现导致功能无法正常运作的更改，但几率极低。

这些 Open Cloud 文档页面将于 2026 年 3 月 31 日移除。届时你将被自动重定向到新的 Open Cloud 文档。{linkStart}了解更多{linkEnd}

这些旧 Open Cloud 页面将于 2026 年 3 月 31 日移除并重定向。{linkStart}了解更多{linkEnd}

实验性终端节点已准备好供公众使用，但随着 API 协定的最终确定，可能偶尔会出现重大变更。

此终端节点可通过使用 API 密钥的 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 在体验中调用。

此字段可能在创建资源时被设置，但可能无法在后续请求中修改。

这些字段可能在创建资源时被设置，但可能无法在后续请求中修改。

此字段可以在请求中提供，但永远不会包括在答复中。

旧版验证方法。始终首选使用 API 密钥或 OAuth 2.0（如有）。

每个 API 密钥：每个 IP 地址每 {periodInSeconds} 秒有 {maxInPeriod} 次请求

无需身份验证即可调用。通常会显著降低速率限制。始终首选使用 API 密钥或 OAuth 2.0（如有）。

对于每个分组，只需提供架构中的以下字段之一，其余字段可以排除。

你可以随时重新选择加入。{linkStart}提供反馈。{linkEnd}

你正在查看旧版文档。{linkStart}提供反馈。{linkEnd}

你可以随时退出，并重定向回旧的引用页面。{linkStart}在这里提供反馈。{linkEnd}

你正在查看全新改版的文档。{linkStart}提供反馈。{linkEnd}

此字段可能被设置为响应，但在请求中将被忽略。

注意：在高流量期间，速率限制可能会更低。某些终端节点有额外的速率限制。[进一步了解速率限制]({link})。

用户或群组所有 API 密钥每天 {limit} 个请求

用户或群组所有 API 密钥每小时 {limit} 个请求

用户或群组所有 API 密钥每分钟 {limit} 个请求

用户或群组所有 API 密钥每秒 {limit} 个请求

每个 API 密钥所有者每分钟 {limit} 个请求

每个 App 用户每天 {limit} 个请求

每个 App 用户每小时 {limit} 个请求

每个 App 用户每分钟 {limit} 个请求

每个 App 用户每秒 {limit} 个请求

每个 API 密钥所有者每秒 {limit} 个请求

范围可以控制你的凭据拥有哪些权限。你的凭据只能访问你所选范围支持的终端节点。

稳定终端节点已准备好投入生产使用，在其生命周期内几乎不会发生重大变更。

此目标允许你将密钥的访问权限限制为选定的{requiredParts}

此目标允许你将密钥的访问权限限制为选定的{requiredParts}和{optionalParts}

目标类型用于限制你的凭据可操作的资源。即使你的帐户拥有其他资源的权限，也只能处理选定的资源。某些范围没有目标部件，在这种情况下，你的所有相关资源都可进行操作。

对于用户拥有的 API 密钥，无需选择宇宙顶级部件。在这种情况下，你的 API 密钥可以访问你拥有的所有个人体验，以及你在群组中拥有相应权限的群组体验。

尚不支持试用需要 API 密钥或 OAuth 2.0 验证的终端节点

为了安全起见，已停用高风险操作的 Cookie 验证。

关键风险终端节点非常敏感，为了安全起见，已停用“试用”

注意：此代码示例中不包含验证标头。你可能需要添加验证标头，以便此命令能够正常运作。

这是会修改或删除关键数据的高风险终端节点。测试时要格外小心。

此 API 终端节点已被归类为高风险，可能会影响实时数据或用户帐户。

对高风险 API 的已验证请求可能会进行无法撤销的更改。请在继续之前仔细查看你的请求参数。

这是会取回数据的低风险终端节点。通常可以安全测试。

这是会修改数据的中风险终端节点。请使用非关键帐户仔细测试，因为更改可能是永久性的。

为了确保你帐户的安全，请不要在此处粘贴来自其他来源的文本，或将此页面的信息发送给其他人。

你即将使用实际帐户凭据测试实时 API 终端节点。

只有在你了解即将进行的 API 调用的影响后才能继续。在测试之前，请仔细查看 API 文档。

将使用已验证的会话进行 API 调用

这些是可能影响你帐户或数据的真实 API 调用

某些操作可能会修改或删除数据

此终端节点已被以下推荐的替代终端节点取代：

调用此终端节点需要以下范围。如需
有关生成正确密钥的更多信息，请参阅 [管理 API 密钥]({apiKeyReferenceDocLink})。

如需有关生成密钥的更多信息，请参阅 [管理 API 密钥]({apiKeyReferenceDocLink})。

相对于基础 URL 的路径，下列端点是可用的。

此字符串格式为 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可以是 “null”、“boolean”、“string”、“number”、“array” 或 “object”。

你的 OAuth 2.0 应用程序需要以下范围才能使用此终端节点。如需进一步了解如何注册 OAuth 2.0 应用程序，请参阅 [App 注册和审核]({oauth2ReferenceDocLink})。

如需进一步了解如何注册 OAuth 2.0 应用程序，请参阅 [App 注册和审核]({oauth2ReferenceDocLink})。

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

调用此终端节点需要以下范围。

资源路径

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】({oauth2ReferenceDocLink})。

不推荐

你正在查看更新后的 Open Cloud 引用。

你已退出新的 Open Cloud 引用。

授予配置账单账户和购买广告点数的权限。

创建、更新和管理你的广告活动。

这将允许查看关于你素材的信息。

这将允许在 Roblox 上传或更新素材。

允许查看你的帐户有权访问的主体（包括群组和体验）和素材。

这将允许向你帐户有权访问的任何主体（包括群组和体验）和素材授予素材权限。

允许代表你查看虚拟形象自动设置任务的状态和结果。

允许代表你创建和管理虚拟形象自动设置任务。

授予更新用户拥有的徽章的能力。

这将允许查看有关你商业项目的信息。

这将允许更改你的同步商业项目。

这将允许查看有关你商户联结平台的信息。

这将允许编辑你的商户联结平台。

这将允许你查看关于你创作者商店产品的信息。

这将允许你修改关于你创作者商店产品的信息。

这将允许你查看关于你创作者商店保存的信息。

这将允许你修改关于你创作者商店保存的信息。

授予代表你创建数据存储的权限。

授予代表你删除数据存储的权限。

授予读取数据存储列表的权限。

授予拍摄数据存储快照的权限。

授予在数据存储中创建条目的权限。

授予标记要删除的指定条目的权限。

授予列出数据存储条目的权限。

授予读取数据存储中指定条目的权限。

授予更新条目的值、属性和用户的权限。

授予删除数据存储条目修订的权限。

授予列出数据存储条目修订的权限。

授予读取数据存储条目修订的权限。

授予查看授权用户的开发者产品配置详细信息的权限。

授予编辑授权用户的开发者产品的权限。

这将允许查看有关你宇宙环境的信息。

授予查看授权用户的游戏通行证配置详细信息的权限。

授予编辑授权用户的游戏通行证的权限。

授予查看你的帐户社区论坛信息的权限。

授予访问权限，允许管理你的帐户对应的社区论坛信息。

这将允许查看有关你社区的信息。

这将允许你管理社区加入请求，并处理你帐户中低级别社区成员的角色更新。

允许你修改实例的属性数据（目前仅支持脚本）。

这将允许查看你的道具栏信息。

授予权限，以管理你的徽章并使用 Robux。

授予更新授权用户徽章的权限。

授予读取你已开启通知的体验信息的权限。

授予代表你开启或关闭体验通知的权限。

授予读取和写入本地化表格的权限

授予为你拥有的所有体验管理团队协作的权限。

授予管理体验和与体验相关的某些信息（例如本地化信息）的权限。

授予读取体验本地化信息的权限。

授予修改体验本地化偏好设置的权限。

授予修改用户本地化偏好设置的权限。

允许你查看关联场景的 Luau 执行任务的状态、日志和结果。

允许你为关联场景创建新的 Luau 执行任务。

授予异步清空宇宙中所有数据结构的权限。

授予从队列前端丢弃已读项目的权限。

授予读取队列前端项目的权限。

授予读取记忆存储项目的权限。

授予创建、更新和删除地图项目的权限。

授予代替用户发布信息的权力。

这将允许从你的体验向用户发送通知。

（已弃用）授予读取有序数据存储中条目列表的权限。

（已弃用）授予在有序数据存储中创建新条目的权限。

授予从有序数据存储中列出条目的权限。

授予在有序数据存储中创建条目的权限。

这将允许列出与你的作品相关联的密钥。

这将允许创作和更新与你的作品相关联的密钥。

此权限允许你提交评估工作并查看工作结果。

授予读取订阅产品信息的权限。

授予创建或修改分析提醒的权限。

授予写入游戏分析相关资源的权限。

授予在 Roblox 上发布新版本体验的权限。

允许读取体验的缩略图和缩略图个性化设置。

允许上传和删除缩略图，并管理体验的缩略图个性化设置。

授予编辑授权用户体验的权限。

允许你查看体验中的用户限制。

允许你编辑体验中的用户限制。

允许查看发送至你帐户的通知。

授予读取用户 Premium 和验证状态的能力。

这将允许你查看授权用户的社交帐户。

这将授予读取你的个人资料信息的权限。

此函数将在可能是立即返回，但在返回值之前可以暂停调用自己的线程。

了解更多关于{linkStart}功能{linkEnd}的信息。

Roblox 已不再支持或维护{nameStart}名称{nameEnd}。

Roblox 不再支持或维护此终端节点。

Roblox 已不再支持或维护这项数学运算。

此成员未在对象浏览器中出现，不应广泛使用。

此成员只能通过命令行访问。从脚本尝试访问此成员将导致错误。

此函数无法暂停调用自己的 Lua 线程。

从脚本尝试访问此成员将导致错误。你可能可以从 Roblox Studio 的属性窗口访问。

此成员不在 Roblox Studio 的对象浏览器中。

你无法使用 Instance.new 构造器创建此类别的实例。

Roblox 不会在跨服务器与客户机界限而复制此成员。

Lua 编程码无法访问此成员。你可能可以从 Roblox Studio 的属性窗口更改其值。

此会员可以从 OpenCloud Luau 执行任务访问。

此对象的复制行为取决于拥有它的玩家。

此成员可以通过命令行和插件访问。从脚本尝试访问此成员将导致错误。

此成员为只读。尝试写入此成员将会导致错误。

此属性为只读，可以从未同步的线程读取。尝试写入可能会导致错误。

可使用其他终端节点来取代此终端节点。

只有 Roblox CoreScript 可以访问此成员，Players 不可用。

你可以安全地从多线程对此属性进行读写。

此类别为顶级类单例。使用 GetService 函数获取此类别的实例。

可在通过 {link1Start}RunService:BindToSimulation(){link1End} 绑定的回调中访问。参与回滚。请参阅{link2Start}服务器权限{link2End}。

多线程可以写入此属性，所以从未同步的线程读取将会有风险。

此函数在返回借过前将会暂停调用自己的的线程。此操作不会中断其他脚本。

在一处集中并方便地管理并分析你的全部体验。

面向所有创作者的文档和资源。

通过指南、教程和代码示例学习如何打造 Roblox 体验。

使用我们一体化的集成开发环境 Studio，打造你的专属体验并部署至多种设备。

将你的标准 R15 虚拟形象转换为带手指关节的高级骨架！

一位工程经理分享如何利用 AI 进行游戏开发。

将 Studio MCP 服务器连接到你最喜欢的 AI 编程工具。

为受众持续提供价值的可靠方式

使用广告管理器选择受众、控制支出并衡量影响力。

自 3 月以来，对于大多数使用新广告管理器的创作者，每个游戏会话的成本下降了 44%，高质量游玩率提高了 89%。

使用广告管理器为你的体验寻找用户！

为你的游戏寻找初始玩家的绝佳方式！

使用“重新激活用户”目标吸引用户回归

了解如何创建成功的广告，为你的作品吸引流量

通过文字聊天信号和自定义匹配机制，让体验具有社交功能。

绘制体验增长图表，发现改进机会

Learn how to get started from the animator of Illegal Soccer.

了解如何为角色和环境添加动作

本次 2026 年 4 月更新推出了用于加速开发的新工具。

Roblox 团队回答了玩家关于最新功能的问题。

Hal_Apenyo 为你介绍如何为 FPS 构建素材库

了解如何上传或在创作中使用商店素材

通过自动配置功能，快速创建时尚靴子！

了解如何在不到 5 分钟的时间内将模型转换为虚拟形象。

创建虚拟形象道具并发布至商城

了解你可以在商城中制作和销售的内容

每个 Roblox 用户都可以通过虚拟形象自定义角色

从零开始创作时尚的包包和饰物！

在创作者中心管理永久和临时封禁。

查找其他创作者制作的模型、脚本和插件

两个全新计划，通过营销支持、实践合作伙伴以及与 Roblox 团队的直接联系，帮助你将愿景转化为可供发布的游戏。

了解如何从 Roblox 自己的 3D 艺术家那里学习为你的虚拟形象道具创建笼状网格

了解过场动画、镜头抖动以及自定义镜头系统。

了解如何配置角色，确保所有虚拟形象功能均可正常运作

了解如何创建对象，与世界或其他用户交互

了解关于低端设备客户端内存使用的最佳做法。

如果你使用过其他引擎，不妨熟悉一下 Roblox 上的开发流程。

在 Roblox 上制作并销售你的第一款基本服装道具

了解如何放置代码，以及如何按类型或功能进行组织。

你可使用 Studio 的协作工具与团队同时工作

参加其他创作者举办的社区活动

了解如何实现联系人邀请奖励系统

通过内容更新保持玩家参与度并实现盈利

通过趣味的重复性游戏玩法来提升参与度和进度

制作你的第一个场景，开启创作者之旅。

了解如何在不编写任何代码的情况下创建滑动门

创建你的第一个体验，或下载 Roblox Studio 以解锁完整的创作工具包。

Alex 分享了创作热门体验《越狱》的第一手经验

Blake 热衷于制作逼真而古怪的嘉年华游戏

Clemens 是一个由家族所有的工作室，制作了《The Survival Game》等热门游戏

Jasmine 是一名艺术家，创作了商城中的一些热门虚拟形象道具

Jessica 是一名设计师，设计了《Alo Yoga》等富有想象力的环境

Jenni 是一名 UGC 创作者和艺术家，参与了许多热门合作

Morphist 风格独特，融合了可爱风与 Emo（忧郁）美学

Riotfall 的创作者们四处旅行，为他们的沉浸式环境寻找灵感

Stephen 分享了自己对编程工具的热爱

Sam 分享了自己如何开始设计时尚道具，把愿望变为现实

所有用于创建 3D 世界的对象，例如零件和照明

使用数据存储来保存玩家进度并处理玩家位置。

了解 Studio 可用调试工具的范围

在测试时使用开发者控制台来调试你的体验

为你的体验添加订阅功能，有助于与用户群建立长期关系。在 2023 年 12 月 15 日之前启用订阅功能，即可享受 3 个月的优惠价格。

将富有表现力的 NPC 对话添加到你的游戏，无需完整的配音。

开始使用 Studio，Roblox 的创作引擎

了解 Alex Seropian 如何最终来到 Roblox，并深入了解他的创作方式。

添加几行代码即可解锁新面板，了解玩家的上手情况和其他漏斗，并跟踪游戏内的经济体系。

Minty 向 Enyu 讲授关于建设性的实心几何形状。

以结构化序列的形式构建实时、跨服务器的事件和过场动画

了解如何为你的体验打造时间型事件

创建基于时间的活动，在 Roblox 上提高可发现性。公布更新内容，突出显示活动，或与玩家一起庆祝里程碑！

了解如果通过体验准则来针对适合你创作的年龄群体。

直接从 Roblox 获取知识和专业技能

用三车道设计开发你的下一款第一人称射击游戏。

了解如何实现好友邀请奖励系统

了解如何管理将你的数据用于训练 AI 的方式。{linkStart}了解详情{linkEnd}

使用我们的 AI 工具轻松创建自定义纹理

使用我们的一体化创作引擎，构建你能想象的任何内容

PolarCub 分享了制作 UGC 道具的所有技巧和窍门

voguebrunette 带你创作发型。还有发箍！

加入众多优秀创作者的行列，参加万圣节游戏大赛

了解硬件测试对你的开发过程有何重要意义。

使用头部来创建脸部动画或触发动作

使用指标来了解可以在哪些方面改进游戏玩法

用户可以输入内容，与你的体验环境进行交互

深入研究案例，构建易于扩展的控制方案。

加入全球创作者的行列，参加研讨会、游戏大赛以及更多精彩活动。

创建可伸缩并贴合任何虚拟形象身体的服装

在 Roblox ，我们相信实践是最好的学习方式。从我们的指南中选择一个，进一步了解平台提供的更多内容。

获取编程方面的帮助，并询问创作方面的问题

你可以通过 Lighting 和 SoundService 控制环境效果

深入了解如何为环境添加光照和地形。

了解如何根据不同的语言和文化习俗调整你的内容

Roblox 的 LOD 设置可以让你的体验更精美、运行更顺畅。

什么时候使用 Luau 中的面向对象编程 (OOP)？

本教程涵盖附件、梁和一些基本脚本概念，向你展示如何在玩家触碰到某物时将玩家的生命值设置为 0

培养活跃的玩家基础是开发一款成功且经久不衰的游戏的重要部分。

了解如何使用 LuauHeap 工具来监控内存使用情况。

开始使用性能优化和故障排除工具

Microprofiler 为任务计划程序提供时间信息

了解模块脚本的工作原理以及何时使用。

了解如何使用指标取得更大的成功

提高计算密集型 Luau 脚本的性能

查看你的每日基准、洞察和实时指标，将“{boldStart}{experienceName}{boldEnd}”的游玩体验提升到新高度。

请在 5 月下旬之前检查你是否符合发布条件。

了解如何在体验中使用 NPC（非玩家角色）

@minty 在直播中使用聊天频道中的建议，从零开始创建了一款障碍跑游戏

我们的平台为你提供无以伦比的创作机会。现在就开始探索创作者中心、Roblox Studio 和我们充满活力的创作者社区吧！

我们的平台为你提供无以伦比的创作机会。

申请参加我们的“启航”和“孵化”计划，在 Roblox 上打造下一款大热游戏。

探索并充分利用全球热门大 IP 的粉丝群体资源。

在我们的新版人才中心申请顶尖工作室的全职或兼职工作机会。

我们的社区由获奖工作室和自学成才的创作者组成，他们都和你一样，从这里起步。

Roblox 的首席环境艺术家介绍如何以及为什么使用工具包

了解如何处理最常见的性能问题。

员工直播，涵盖重力、材质属性和约束

了解用户加入体验时会发生什么

插件可为你的创作添加额外功能

让我们参观 PolarCub 的 UGC 主页商店！此外，Temprist 也会出现。

完善素材、修饰地形、添加效果等等。

在 Roblox 上处理程序化模型的高级技巧与窍门。

了解如何为你的作品吸引流量和关注

查看专家见解，了解如何销售和推广虚拟形象道具。

了解在 Blender 中制作虚拟形象道具的高效工作流程。

Madison_Hatter2 讲解如何为简单的虚拟形象道具添加纹理并发布。

了解处理雨水效果的三种不同方式的优缺点。

了解我们的创作引擎能实现的可能性

使用推荐服务呈现个性化内容。

借助全新的重新导入功能，更轻松地对模型进行迭代。

了解如何在体验中实现激励视频广告。

听《Dead Rails》创作者分享，如何打造并运营自己的工作室。

学习如何为 R15 人形角色模型设置骨架

在 Roblox 上制作并销售你的第一款基本刚性配饰

预览 Roblox 上即将推出的全新功能和产品。

Studio 是让你在 Roblox 上创建体验的工具

DucksAreYellow 和 Rush Bogin 讨论 UGC 的最佳做法和要点。

了解如何使用 Studio 中的脚本编辑器创建自定义脚本

Andrew 向你展示了如何放置脚本，使其正常运行。

你可以使用脚本在体验中为用户加入沉浸式互动

现在，你可以在新的广告管理器中投放主页和搜索广告。{learnMoreLinkStart}了解更多{learnMoreLinkEnd}

了解乐观机制与时间回溯如何为服务器权威测试版提供动力。

观看本次开发者访谈，了解多玩家竞争的运作方式。

在 Roblox 上制作并销售你的第一双鞋子。

了解 Studio 快捷键和关键命令，以便加快构建速度

即使目标值发生变化，也能保证平稳过渡。

了解如何集成功能，让玩家与朋友一起玩

了解如何集成功能，让玩家与联系人一起玩

创建赞助广告，让你的创作触达更多创作者

Jason 演示如何制作一款具备安全移动机制的喷气背包游戏。

了解有关使用有限状态机进行 NPC AI 编程的所有信息。

何时应考虑使用 UnreliableRemoteEvent？

与团队合作，或仅仅是用评论记录自己的想法。

深入了解如何在 Roblox Studio 中调试代码。

Studio 是在 Roblox 上用来创作的全方位工具。立刻试试，发挥你的创意！

了解如何为玩家提供按月付费的持续福利

与其他创作者合作，共同发展你的创作体验

使用地形编辑器来生成和改变 Studio 中的地形

通过个性化设置，“{boldStart}{experienceName}{boldEnd}”等体验的平均合格游戏会话率提高了 8.5%。

了解在 Roblox 体验中判断时间的所有最佳方法。

与 Marcus 一起打造俯视视角镜头，非常适合制作全新的 RTS、MOBA 或 ARPG 游戏。

翻译可以帮助你的创作触达更多样的用户

Minty 和 SCHLEEMPH 带你浏览全新的 UGC 主页商店模板

探索 GUI 对象的阴影和分边角圆角设置。

使用新的样式管理工具来创建、管理和应用界面样式。

了解如何为 Roblox 的独特受众群体构建体验

它们是什么，以及如何使用它们构建体验

了解 Roblox 如何验证虚拟形象 UGC 头部以及其他有用的提示。

了解有关场景版本、工具包和脚本历史记录的所有信息。

 请先观看一个在 Roblox 上创作的简介视频，并前往 Studio

在你的体验页中添加游戏预览视频！

使用此按钮可再次展开更新侧边栏。

一站式简便管理和发展你的作品

跟踪任何作品的绩效指标和用户参与度

现在，你可以监控所有群组的体验

Workspace（工作区）是用来存放你希望引擎在项目中渲染的对象的地方

员工直播，涵盖部件、网格、地形和光照

继续创建你的体验，或获取 Roblox Studio 以解锁完整的创作工具包。

UGC 纹理制作简介，特邀嘉宾：Madison_Hatter2

点击这里查看更新

每个公开体验都必须具有内容成熟度标签才能游玩。