维护一个流连接。要处理流事件，可以使用
`Datatype.RBXScriptSignal:Connect()`将回调函数连接到每个事件。


当服务器成功关闭连接或用户调用
`Class.WebStreamClient:Close()` 时触发。


WebStreamClient.Closed

当在建立连接或连接生命周期内接收到错误时触发。


WebStreamClient.Error

responseStatusCode

标准的 HTTP 错误状态代码（例如，404，500）。


errorMessage

包含有关错误详细信息的描述性消息。


每次从服务器接收到消息时触发。格式根据 `Enum.WebStreamClientType` 而有所不同。


WebStreamClient.MessageReceived

message

从服务器流接收到的消息数据负载。


每次从服务器接收到消息时触发。


当客户端和服务器之间成功建立连接时触发，允许事件开始流式传输。提供原始格式的响应头，可以用于验证。


WebStreamClient.Opened

标准的 HTTP 成功状态代码（例如，200）。


headers

来自服务器的原始 HTTP 响应头。


当客户端和服务器之间成功建立连接时触发，允许事件开始流式传输。


关闭客户端，终止正在进行的请求。如果成功，将触发
`Class.WebStreamClient.Closed`事件。


WebStreamClient:Close

关闭客户端，终止正在进行的请求。


将数据入队以通过连接传输到服务器。仅对使用`Enum.WebStreamClientType.WebSocket`创建的客户端有效。对其他客户端类型无效。


WebStreamClient:Send

data

要发送到服务器的文本字符串。


将数据入队以通过流连接传输到服务器。


WebStreamClient

客户端的当前 `Enum.WebStreamClientState`。


WebStreamClient.ConnectionState

`Object` 是 Roblox 类层次结构中所有类的基类。
Roblox 引擎定义的每个其他类都继承 `Object` 的所有成员。
无法直接创建 `Object`。


此示例演示了普通对象和 `Value` 对象上 `Changed` 事件的细微差别。


此代码示例演示了父对象中 Changed 事件的触发。

此事件在对象的属性变化后立即触发，但存在某些例外（见下文）。更改属性的新值 **不** 会作为参数传递。相反，可以使用 `object[property]` 访问：

```
object.Changed:Connect(function(property)
	print("新属性的值是", object[property])
end)
```

- 如果您只对监听一个特定属性的变化感兴趣，请考虑使用 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` 方法。
- 要监听属性变化，请参阅 `Class.Instance:GetAttributeChangedSignal()` 和 `Class.Instance.AttributeChanged`。
- 要检测子对象的添加或删除，请参见 `Class.Instance.ChildAdded` 和 `Class.Instance.ChildRemoved`。

对于诸如 `Class.IntValue` 和 `Class.StringValue` 的 `Class.ValueBase` 对象，仅在对象的 `Value` 属性变化时触发此事件。要检测其他 `Class.ValueBase` 对象的变化，请使用 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`。

#### 限制

此事件 **不** 会针对物理相关的变化触发，例如 `Class.BasePart.CFrame|CFrame`、
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`、
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`、
`Class.BasePart.Position|Position` 或 `Class.BasePart.Orientation|Orientation` 属性由于重力而变化。要检测这些属性的变化，可以考虑使用物理事件如 `Class.RunService.PreSimulation`。
类似地，当 `Class.BasePart.AssemblyMass|AssemblyMass` 由于材料、大小或密度变化而更新时，`Changed` 事件不会触发（但如果你修改一个部件的大小，则会触发 `Class.BasePart.Mass|Mass` 事件）。

对于频繁变化的属性, `Changed` 事件可能不会针对每次修改触发，或根本不会触发。**如果属性变化影响你的游戏逻辑，请仔细测试**，以确保事件按预期触发。


Object.Changed

property

在对象的属性变化后立即触发，但有某些限制。


这段代码示例演示了如何在变更事件触发之前保存一个值，以便获得更多关于更改的信息。

这个代码示例演示了 `Changed` 事件与 `GetPropertyChangedSignal` 返回的事件之间的等价性。

此方法返回一个事件，其行为与 `Class.Object.Changed|Changed` 事件完全相同，不过它仅在给定属性变化时触发。通常，建议使用此方法，而不是连接到 `Class.Object.Changed|Changed` 的函数来检查属性名称。对同一对象同一属性名称的后续调用返回相同的事件。

`Class.ValueBase` 对象，如 `Class.IntValue` 和 `Class.StringValue`，使用修改过的 `Class.Object.Changed|Changed` 事件，该事件在其 `Value` 属性的内容变化时触发。因此，此方法提供了一种检测这些对象其他属性变化的方式。

请注意，此事件不会将任何参数传递给连接的函数，因此必须在脚本中直接读取变化的属性值。

#### 限制

此方法返回的事件 **不** 会针对物理相关的变化触发，例如 `Class.BasePart.CFrame|CFrame`、
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`、
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`、
`Class.BasePart.Position|Position` 或 `Class.BasePart.Orientation|Orientation` 属性由于重力变化而发生的变化。要检测这些属性的变化，可以考虑使用物理相关事件，例如 `Class.RunService.PreSimulation`。

此外，返回的事件可能不会在每次修改频繁变化的属性时触发，或者对于此类属性根本不会触发。建议您仔细测试影响游戏逻辑的属性变化。


Object:GetPropertyChangedSignal

一个在属性发生变化时触发的信号。


获取当对象的给定属性发生变化时触发的事件。


演示如何使用 `Class.Instance:IsA()` 确定 Workspace 的类

Workspace 是 'Workspace' 类，因此第一个语句为真。Workspace
不是 'BasePart' 类，因此第二个语句为假。Workspace
继承自 Instance，因此是 'Instance' 类，所以第三个
语句为真。


IsA 如果对象的类与给定类 **等价** 或是 **子类**，则返回 true。此函数类似于其他语言中的 **instanceof** 操作符，是一种 [类型自省](https://en.wikipedia.org/wiki/Type_introspection) 的形式。要忽略类继承，请直接测试 `Class.Object.ClassName|ClassName` 属性。对于检查原生 Luau 数据类型（数字、字符串等），请使用 `type` 和 `typeof` 函数。

通常，这个函数用于测试对象是否某种类型的部件，如 `Class.Part` 或 `Class.WedgePart`，这些类都继承自 `Class.BasePart`（一个抽象类）。例如，如果你的目标是将角色的所有肢体更改为相同的颜色，你可以使用
`Class.Instance:GetChildren()|GetChildren` 迭代子对象，然后利用 IsA 筛选出缺少 `Datatype.BrickColor` 属性的非 `Class.BasePart` 对象：

```lua
local Players = game:GetService("Players")

local function paintFigure(character, color)
	-- 迭代角色的子对象
	for _, child in character:GetChildren() do
		-- 筛选掉非部件对象，如 Shirt、Pants 和 Humanoid
		-- R15 使用 MeshPart，R6 使用 Part，因此我们在这里使用 BasePart 来检测两者：
		if child:IsA("BasePart") then
			child.BrickColor = color
		end
	end
end
paintFigure(Players.Player.Character, BrickColor.new("Bright blue"))
```
由于所有类都继承自 `Class.Object`，因此调用 `object:IsA("Object")` 将始终返回 true。


Object:IsA

className

将对其检查对象类的类。
区分大小写。


描述对象的类是否与给定类匹配或是其子类。


如果对象的类与给定类匹配或继承，则返回 true。


Object:isA

Object

一个只读字符串，表示这个 `Class.Object` 所属的类。

此属性可与各种其他函数一起使用，这些函数用于通过类型识别对象，例如 `Class.Object:IsA()` 或
`Class.Instance:FindFirstChildOfClass()`。

请注意此属性是只读的，无法被脚本修改。
希望更改对象类的开发者需要创建一个新的 `Class.Object`。

与 `Class.Object:IsA()` 不同，ClassName 可以用于检查对象是否属于特定类而忽略类继承。例如：

```
for _, child in workspace:GetChildren() do
    if child.ClassName == "Part" then
        print("找到一个 Part")
        -- 将找到模型中的 Parts，但不包括 TrussParts、WedgeParts 等
    end
end
```


Object.ClassName

一个只读字符串，表示这个 `Class.Object` 所属的类。


Object.className

`Object` 是 Roblox 类层次结构中所有类的基类。


/reference/engine/classes/WebStreamClient.yaml

Luau

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

Data Type

RBXScriptSignal

WebStreamClientState表示WebStreamClient对象的当前状态。

Enum

Enum.WebStreamClientState

boolean

number

一系列字符，如字母、数字和符号。

string

体验

虚拟形象

素材

范例和项目

引擎 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 和验证状态的能力。

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

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