ClientRequest

Timeout

InvalidHost

Disconnected

ServerShutdown

服务器终止连接，因为它已关闭。

ServerProtocolMismatch

服务器使用了错误版本的协议。

ConfigurationFailed

RpcError

DebuggerEndReason

/reference/engine/enums/DebuggerEndReason.yaml

一个在特定事件发生时运行连接的函数的对象。

Data Type

RBXScriptSignal

概览

体验

虚拟形象

素材

Open Cloud

Create

探索

本地化

分析

设计

Scale

Monetize

Education

All Courses

Courses

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

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

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

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

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

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

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

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

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

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

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

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during its lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看 【管理 API 密钥】({apiKeyReferenceDocLink})。

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

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

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

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

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

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

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

The following scopes are required to call this endpoint.

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

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

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

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

Grants access to mange your badges and spend robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

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

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

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

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

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

此操作将会允许发布作品的新版本至 Roblox。

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

使用为全部创作者设计的学习文档和资源

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

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

Dependable ways to offer value over time to your audience

Since March, most creators who used the New Ads Manager experienced a 44% drop in cost per play and an 89% increase in quality play-through rates.

Find users for your experience with Ads Manager!

A great way to find initial players for your game!

Use the Reactivate Users objective to bring users back

在 Roblox 上发行广告可以吸引全球观众，为你的内容带来更多流量的机会。

Chart your experience's growth and discover opportunities to improve

动画是将动作和动作应用于角色、对象和环境的过程，以创造一种吸引人的动态体验。

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

Learn how to convert a model into an avatar in less than 5 minutes.

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

Sorted by highest revenue over the last 7 days

Learn about what you can make and sell on the marketplace

每个 Roblox 用户都由一个可自定义的角色来代表，这个角色叫做虚拟形象。

Manage your permanent and temporary bans from Creator Hub.

Learn basic modeling techniques in blender

Find models, scripts, and plugins made by other creators

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

Learn about cutscenes, camera shake, and even custom camera systems.

角色模型需要一组特定的组件和配置标准，以确保所有虚拟形象功能都能正常运行。

角色通常是指与世界或其他用户互动的任何模型对象。

Learn best practices around client memory usage on low-end devices.

Make and sell your first basic clothing item on Roblox

Learn where to put code and how to organize by type or by feature.

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

Check out what's trending on the Creator Store

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

Learn how to implement a Connection invite reward system

Keep players engaged and monetized with content updates

Captivate your audience with an enjoyable gameplay cycle

Drive engagement and progress with fun, repetitive gameplay

Kick off your creator journey by making your very first place.

Learn how to create a sliding door without writing any code

Alex shares first-hand experience behind creating the hit experience, JailBreak

Blake found a passion in making realistic, quirky carnival games

The Clemens are the family-owned studio behind hits like The Survival Game

Jasmine is the artist behind some of the most popular avatar items on Marketplace

Jessica is the designer behind imaginative environments like in Alo Yoga

Jenni is the UGC creator and artist behind many popular collaborations

Morphist’s unique style combines cutesy and emo aesthetics

The Riotfall creators travel to find inspiration for their immersive environments

Stephen shares their love of programming tools

Sam shares how they got started designing fashion items that they wish existed

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

Use data stores to save player progress and handle player position.

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

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

Adding subscriptions to your experience helps build long term relationships with your user base. Enable subscriptions before December 15, 2023, and enjoy 3 months of lower rates.

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

Add a few lines of code to unlock new dashboards to understand your onboarding and other funnels and track your in-game economy.

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

EventSequencer 是一个强大的框架，可以让你在一系列有组织的动作和触发器上，实时生成跨服务器的事件和过场动画。

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

Create time-based events for increased discoverability across Roblox. Announce your latest update, highlight an activity, or celebrate a milestone with your players!

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

Gain knowledge and expertise directly from Roblox

Learn how to implement a friend invite reward system

Learn how you can control how your data is used to train AI. {linkStart}Read More{linkEnd}

Easily create custom textures using our AI tools

Use our all-in-one creation engine to build anything you can imagine

PolarCub shares all the tips tricks to make UGC items

Learn best practices for blocking out your environments.

Catch up with voguebrunette and create a hairstyle. With a headband!

Join our incredible cast of creators for a Halloween game jam

支持面部动画的头部部分是一个专门带皮肤的头部网格部件。

Using metrics to understand where you can improve your gameplay

Figure out how to keep them coming back to your game

每个体验都需要以某种方式接收用户输入，以便用户进行交互并查看其环境。

Guide players through their first time playing your experience

“层叠服饰“是一种装扮配件，可以自然地伸展并贴合任何外形和现有的层叠道具。

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

Get help writing code and answers to your creation questions

借助"照明与音响服务"容器服务，你可以控制和自定义环境效果。

Take a deep dive into lighting your environment and adding terrain.

Roblox 用户来自全世界的各种文化背景，说着不同的语言。

Object-oriented programming in Luau. When does it make sense?

This walkthrough covers attachments, beams, and some basic scripting concepts that shows you how to set player health to 0 if they touch something

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

Learn how to use the LuauHeap tool to keep an eye on memory usage.

Get started with the performance optimization and troubleshooting tool

MicroProfiler 是 Roblox Studio 和 Roblox Client 中的一种优化工具，可为任务计划程序进程提供详细的时间信息。

Dive deep into frame colors, flame graphs, and more

Learn how module scripts work and when to use them.

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

Improve the performance of computationally intensive Luau scripts

View your daily benchmarks, insights, and real-time metrics to take {boldStart}{experienceName}{boldEnd} to the next level.

NPC（非玩家角色）可以为体验增加很多深度。

@minty creates an obby live from scratch using suggestions from chat

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

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

Our community of award-winning studios and self-taught creators all started here, just like you. 

A principal environment artist at Roblox covers how and why to use packages

Learn how to deal with the most common performance problems.

Staff stream about gravity, material properties, and constraints

当用户加入体验时，Roblox 会在数据模型中将其表示为玩家。

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

Let's tour PolarCub's UGC Homestore! Also, Temprist shows up.

Finalize your assets, spruce up your terrain, add effects, and oh my.

Roblox 上的促销活动可以吸引全球观众，为你的体验、虚拟形象道具和社交媒体带来客流量和体验感。

Catch up on all the highlights from this year's RDC

Learn how to sell and promote avatar items with insights from the experts.

Learn efficient workflows for making avatar items in Blender.

Madison_Hatter2 shows how to texture and publish a simple avatar item.

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

Learn how to implement rewarded video ads in your experiences.

R15 人形角色模型（例如构成用户角色的角色）由 15 个单独的网格对象组成。

Make and sell your first basic rigid accessory on Roblox

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

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

DucksAreYellow and Rush Bogin talk best practices and gotchas for UGC.

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

Andrew shows you where to place your scripts, so they run properly.

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

Make and sell your first pair of shoes on Roblox.

Studio 有许多默认的快捷方式和按键命令，可以让你更快、更轻松地进行开发。

What are the pros and cons of the two approaches?

Keep your transitions smooth even when the target value changes.

社交功能为玩家提供了与朋友一起游戏以及与其他玩家互动的方式。

Learn how to integrate features that allow players to play with Connections

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

When should you consider using an UnreliableRemoteEvent?

Collaborate with your team or just jot down your thoughts with comments.

An in-depth look at how to debug your code in Roblox Studio.

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

Learn how to offer players recurring benefits for a monthly fee

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

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

Experiences like {boldStart}{experienceName}{boldEnd} saw an average +8.5% lift in qualified play through rate with personalization.

Learn about all the best methods for telling time in Roblox experiences.

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

Tour the new UGC Homestore template with Minty and SCHLEEMPH

Use the new Style Manager to create, manage, and apply UI styles.

Roblox 的用户群在人口统计数据和预期方面都与其他平台不同。

What are they and how you can use them to build

Learn all about place versions, packages, and script history.

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

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

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

Staff stream covering parts, meshes, terrain, and lighting

Build wild obbies, design epic race tracks, and decorate every detail.
Your world is waiting! Let’s create something epic.

Intro to texturing for UGC ft. Madison_Hatter2

Every public experience must have a content maturity label to be playable.

DebuggerEndReason

项目

在此页面