工坊手册

主题

数据 Data ​

共 92 个类型。

  • Animation: Animation 用于封装动画资源的标识信息，将动画名称与资源 URI 绑定在一起。它作为动画数据的轻量载体，供 Animator 加载动画时使用。
  • Axes: Axes 是由名称字符串构造的轴/面布尔集合，可读取 x、y、z 与 Top、Bottom、Left、Right、Front、Back 是否启用。
  • BitMask: BitMask 是用于表示一组布尔标志的位掩码数据类型。
  • BoundingBox: 轴对齐包围盒用于定义一个三维空间中的矩形区域，通过最小点和最大点确定范围。它提供获取中心点、半尺寸以及读写最小最大点的能力，常用于空间查询、碰撞检测和区域裁剪。
  • CFrame: CFrame 是描述三维空间中物体位置与朝向的坐标帧，既可作为绝对的世界变换，也可作为局部坐标系参与空间换算。它提供位置、旋转矩阵、方向向量等属性，并支持点、向量、坐标帧在相同或不同坐标系之间的相互转换，同时提供角度分解、插值、相似性比较等常用运算。
  • Camp: 阵营是用于组织玩家分组的数据类型，代表游戏中的一个阵营实例。通过它可以在服务端获取当前属于该阵营的全部玩家，并监听玩家加入或离开阵营的动态变化，适合实现按阵营划分的团队玩法、人数统计或阵营归属判断。
  • CollisionCallbackInfo: CollisionCallbackInfo 是 PhysicsUnit、WorldUnit 本地碰撞事件传入的只读回调数据，公开提供 OtherUnit，用于标识与当前单位开始或结束碰撞的另一方。该类型不可直接构造。
  • Color: Color 是 RGBA 颜色类型，用于表示带透明度的颜色值。它提供红、绿、蓝、不透明度四个分量，并支持颜色插值、分量极值比较等运算。
  • Color3: Color3 是 0 到 1 浮点分量的 RGB 颜色值，支持 RGB/HSV/十六进制构造、颜色空间转换和线性插值。
  • ColorSequence: 颜色序列用于定义随时间或进度变化的颜色渐变。它通过一组关键帧来插值生成中间颜色，常用于粒子效果、UI 动画或材质属性动态过渡。
  • ColorSequenceKeypoint: 颜色序列关键帧用于定义颜色渐变序列中某一时刻的颜色值。它由时间位置和对应的颜色组成，是构建 ColorSequence 的基础元素。
  • CommodityInfo: CommodityInfo 是商品信息条目数据，用于承载商品 ID 与数量。
  • Connection: Connection 是事件订阅的句柄，代表一次有效的事件监听连接。它由 Signal:Connect() 返回，用于在不再需要时取消监听，防止内存泄漏。
  • CustomAppearance: CustomAppearance 是由主模型和若干 SubCustomAppearance 子模型组成的可复用外观数据，记录模型资源、皮肤、染色区域、材质、透明度、阴影、旋转与缩放等公开配置。
  • DataStore: 数据存储集合，用于持久化保存玩家或地图的键值数据。支持异步读写、递增、更新、版本管理以及键列表查询，所有操作需在协程环境中调用。
  • DataStoreGetOptions: DataStoreGetOptions 是 DataStore:GetAsync 的可选参数容器，用于控制读取时是否返回 KeyInfo、是否排除已删除条目、是否使用缓存和更新时间排序。
  • DataStoreGetVersionOptions: DataStore:GetVersionAsync / GetVersionAtTimeAsync 的可选参数类型，可通过 DataStoreGetVersionOptions.New() 创建。
  • DataStoreIncrementOptions: DataStoreIncrementOptions 是 DataStore:IncrementAsync 的可选参数容器，用于设置自增初始值、元数据、用户 ID、KeyInfo 返回和前置版本依赖。
  • DataStoreInfo: DataStoreInfo 是 DataStoreService 列表接口返回的集合信息条目，包含集合名称、类型、创建/更新时间、键数量、占用大小和删除状态。
  • DataStoreInfoPages: DataStoreInfoPages 是 DataStoreService:ListDataStoresAsync 或 ListOrderedDataStoresAsync 返回的分页迭代器，GetCurrentPage() 返回 DataStoreInfo 数组。
  • DataStoreKeyBriefInfo: DataStoreKeyBriefInfo 是 DataStore:ListKeysAsync 返回的 key 摘要条目，包含 Scope、Key 和 IsDeleted。
  • DataStoreKeyBriefInfoPages: DataStoreKeyBriefInfoPages 是 DataStore:ListKeysAsync 返回的分页迭代器，GetCurrentPage() 返回 DataStoreKeyBriefInfo 数组。
  • DataStoreKeyInfo: DataStoreKeyInfo 是 DataStore 读写操作返回的键信息对象，包含创建/更新时间、版本号、scope、key、元数据、用户 ID 和删除状态。
  • DataStoreListKeyOptions: DataStoreListKeyOptions 是 DataStore:ListKeysAsync 的可选参数容器，用于控制列 key 时是否排除已删除条目。
  • DataStoreListOptions: DataStoreListOptions 是 DataStoreService 列表接口的可选参数容器，用于控制列 DataStore 集合时是否排除已删除集合。
  • DataStoreOptions: DataStoreOptions 是获取 DataStore 或 OrderedDataStore 句柄时传入的实例级默认选项，后续读写方法未传入自己的 options 时会使用这些默认值。
  • DataStoreRemoveOptions: DataStore:RemoveAsync 的可选参数类型，可控制删除时是否返回键元信息、是否永久删除，以及是否要求当前版本匹配指定前置版本。
  • DataStoreRemoveVersionOptions: DataStoreRemoveVersionOptions 是 DataStore:RemoveVersionAsync 的可选参数容器，可通过 DataStoreRemoveVersionOptions.New() 创建。
  • DataStoreSetOptions: DataStoreSetOptions 是 DataStore:SetAsync 的可选参数容器，用于设置 KeyInfo 返回、元数据保留策略、前置版本依赖、用户 ID 和自定义元数据。
  • DataStoreVersionInfo: DataStoreVersionInfo 是 DataStore:ListVersionsAsync 返回的历史版本条目，包含版本创建时间、版本号和删除状态。
  • DataStoreVersionInfoPages: DataStoreVersionInfo 分页迭代器
  • EUIManager: EUIManager 是当前玩家 PlayerGui 上的 UI 管理器，用于读取设备分辨率、获取 UI 根节点、查询 EUI 节点，以及创建包 UI 模块和场景 UI 节点。
  • EUITouchInfo: EUITouchInfo 用于封装触摸交互过程中的位置信息，记录触摸开始、移动和结束时的屏幕坐标。它通常由 UI 触摸事件回调提供，帮助开发者追踪单次触摸的完整轨迹。
  • EffectBindData: EffectBindData 用于描述 EffectUnit 与目标单位的绑定方式，包括宿主提供的目标单位 ID、挂点、偏移和跟随类型。
  • EggyAppearance: 蛋形生物的可换装外观数据，涵盖蛋皮、染色、时装散件、配饰、脸型、表情、肤色与蛋壳等装扮维度，并支持运行时整体换装、切换表情与脸型、按骨骼插槽挂接或解绑外观件，以及控制头顶气泡消息的显示。
  • Faces: Faces 是面集合数据类型，用于用面名称字符串选择 Right、Top、Back、Left、Bottom、Front 六个方向中的一个或多个面。
  • InputObject: InputObject 封装了用户输入事件的详细信息，包括按键代码、输入类型、状态、位置和变化量。它由 UserInputService 的输入事件自动生成，用于在回调中判断具体输入行为。
  • JoinData: JoinData 封装了玩家进入当前地图时的传送上下文信息，包括来源地图编号、一同传送的其他玩家列表以及传送时携带的自定义数据。通过 Player:GetJoinData 获取该实例后，可读取这些字段来了解玩家是如何到达当前地图的。
  • LogRecord: LogRecord 是 LogService:GetLogHistory 返回的单条历史日志记录。
  • MaterialParam: MaterialParam 是 SkinUnit 的材质参数数据，用于配置粗糙度、金属度、自发光、水体、细节纹理和边缘光等外观表现。
  • Matrix: 矩阵类型，用于表示三维空间中的平移、旋转和缩放组合变换，并可直接读取右、上、前方向向量以及按 ZXY 顺序解释的俯仰、偏航、翻滚角。支持构造单位矩阵、零矩阵，以及通过欧拉角、轴向旋转或两向量间的旋转生成矩阵，还提供了求逆、转置和对向量应用变换等常用运算。
  • Matrix3x3: Matrix3x3 表示一个 3×3 浮点矩阵，用于三维空间中的线性变换计算。它支持矩阵乘法、转置、求逆、行列式与迹等常见运算，并可将矩阵作用于三维向量。
  • MemoryStoreHashMap: MemoryStoreHashMap 是内存级键值存储的哈希集合，提供快速的异步读写能力。它支持对单个键进行设置、获取、更新和删除操作，并能列出所有存储项或清空整个集合。
  • MemoryStoreHashMapPages: MemoryStoreHashMapPages 是 MemoryStoreHashMap:ListItemsAsync 返回的分页迭代器，GetCurrentPage() 返回 { Key = String, Value = Any } 数组。
  • MemoryStoreHashMapSetOptions: MemoryStoreHashMapSetOptions 用于配置 MemoryStoreHashMap:SetAsync 方法的可选行为，通过设置布尔条件、数值比较或生存时间等字段，精确控制键值对的写入策略。它支持存在性检查、值大小比较、累加操作以及键的过期管理，帮助开发者实现复杂的条件更新逻辑。
  • MemoryStoreHashMapUpdateOptions: MemoryStoreHashMapUpdateOptions 用于配置 MemoryStoreHashMap:UpdateAsync 的原子更新条件，支持基于旧值的阈值比较和键的生存时间控制。通过设置 LTT、GTET、EQT 等字段，可确保仅在满足指定条件时才执行更新，避免并发冲突。
  • MemoryStoreQueue: MemoryStoreQueue 是支持整数优先级的临时消息队列，通过 AddAsync 写入任务、ReadAsync 批量读取并暂时隐藏任务，再用 RemoveAsync 确认删除已处理批次。
  • MemoryStoreQueueAddOptions: MemoryStoreQueueAddOptions 用于配置向内存存储队列添加数据时的可选行为，支持设置条目过期时间与存在性前置条件。通过设置 MSXX 或 MSNX 字段，可控制仅在队列存在或不存在时才执行添加操作；EX、PX、EXAT、PXAT 字段则允许以秒或毫秒为单位指定条目的生存时间。
  • MemoryStoreQueueGetSizeOptions: MemoryStoreQueueGetSizeOptions 用于配置 MemoryStoreQueue:GetSizeAsync 方法的可选参数，控制是否在计算队列大小时排除不可见元素。通过设置 ExcludeInvisible 字段，可以灵活调整统计范围，满足不同业务场景的需求。
  • MemoryStoreQueueReadOptions: MemoryStoreQueueReadOptions 是 MemoryStoreQueue:ReadAsync 的读取配置，用于控制是否要求全部读取成功、空队列等待时间以及已读元素的不可见过期时间。
  • MemoryStoreSortedMap: MemoryStoreSortedMap 是内存键值存储中的有序集合，支持按排序键对数据进行排序和范围查询。它提供设置、获取、删除、更新条目以及获取集合大小等操作，适用于需要快速排序和分页读取的场景。
  • MemoryStoreSortedMapGetRangeOptions: MemoryStoreSortedMapGetRangeOptions 用于配置 MemoryStoreSortedMap:GetRangeAsync 的范围查询参数。通过设置键和排序键的上下限，可以精确控制返回的数据范围。所有字段默认为空，表示不施加对应限制。
  • MemoryStoreSortedMapPages: MemoryStoreSortedMapPages 是 MemoryStoreSortedMap:GetRangeAsync 返回的分页迭代器，当前页元素形如 { Key = String, Value = Any, SortKey = Any }。
  • MemoryStoreSortedMapSetOptions: MemoryStoreSortedMapSetOptions 用于配置 MemoryStoreSortedMap:SetAsync 的写入行为，支持条件更新、自增操作和键的生存时间设置。通过组合 XX、NX、LT、GT 等条件字段，可实现仅在满足特定条件时才执行写入；INCR 字段允许对数值型排序键进行原子累加；EX、PX 等字段则控制键的过期策略。
  • MemoryStoreSortedMapUpdateOptions: MemoryStoreSortedMapUpdateOptions 是 MemoryStoreSortedMap:UpdateAsync transform 回调返回的可选参数，用于约束旧 sortKey 条件和 TTL 行为。
  • NumberRange: NumberRange 表示一个由最小值和最大值构成的数值区间，用于限定范围或进行边界检查。通过 NumberRange.New(min, max) 或简写 NumberRange(min, max) 创建实例，可读取 Min 和 Max 属性获取区间端点。
  • NumberSequence: NumberSequence 表示一段随归一化时间变化的数值曲线，可用单个常量值或关键帧数组构造，并通过 Keypoints 读取生成的关键帧。
  • NumberSequenceKeypoint: 数值序列关键帧用于定义数值序列中的一个关键点，包含时间位置、数值和包络三个参数。它通常与 NumberSequence 配合使用，通过多个关键帧来描述数值随时间变化的曲线。
  • OrderedDataStore: 有序数据存储集合，用于存储键值对并支持按值排序检索。它继承自 DataStore，额外提供 GetSortedAsync 方法，可按升序或降序分页获取数据。写入的值必须是整数，适合排行榜、分数记录等需要排序的场景。
  • OrderedDataStoreKeyValueInfo: 有序数据存储键值对信息对象，封装了有序数据存储中单条记录的完整信息。它提供了键名、值、前置域和更新时间等属性，用于在分页查询结果中遍历和读取数据。
  • OrderedDataStoreKeyValueInfoPages: OrderedDataStoreKeyValueInfoPages 是 OrderedDataStore:GetSortedAsync 返回的分页迭代器，GetCurrentPage() 返回 OrderedDataStoreKeyValueInfo 数组。
  • OverlapParams: OverlapParams 是 PhysicsService 空间查询（GetPartBoundsInBox、GetPartBoundsInRadius、GetPartsInPart）的过滤参数，用于精确控制查询返回的 Unit 集合。它允许按实例白名单或黑名单过滤、按已配置的碰撞组过滤，并限制最大返回数量，从而让空间检测更聚焦于目标对象。
  • Pages: 分页迭代器基类，用于分批读取大量数据条目。通过判断是否已迭代完毕来控制遍历流程，支持读取当前页数据与异步推进到下一页。该对象不能直接创建，只能从各类列表查询接口的返回值中获得。
  • PathHitInfo: 寻路射线检测结果，用于描述一条射线与导航网格的碰撞信息。它记录了射线的起点、终点、是否命中、命中点的插值参数以及命中点的世界坐标。
  • PathWaypoint: 寻路路点表示寻路路径上的一个关键位置，包含世界坐标、到达时执行的动作以及自定义标签。它由寻路系统在计算路径后生成，用于指导单位沿路径移动并执行特定行为。
  • PhysicalProperties: PhysicalProperties 描述物理材质的密度、摩擦、弹性及其混合权重，用于配置物体碰撞和接触时的物理表现。
  • PlayerGui: PlayerGui 是当前玩家的客户端 UI 入口，提供 EUIManager 和 ScreenGui 两个常用 UI 控制对象。
  • Quaternion: 四元数用于表示三维空间中的旋转，可避免欧拉角的万向节死锁问题。它提供从轴角、欧拉角构造旋转的能力，并支持球面线性插值、归一化、求逆、旋转向量等常用运算。
  • Ray: Ray 表示三维空间中的射线，由起点和方向向量定义。它提供最近点计算和点到射线距离的几何方法，常用于空间查询和碰撞检测前的数学预处理。
  • RaycastParams: 射线检测的过滤参数，用于控制 PhysicsService 的射线、球体、盒体与形状检测在命中判定时排除或仅保留指定单位，同时支持按碰撞组进行二次过滤。它通过过滤类型、实例列表和碰撞组三个关键字段共同决定最终命中结果。
  • RaycastResult: 射线或形状投射命中后返回的数据结构，包含被命中的单位、命中点、命中面法线和命中距离。开发者通过它获取碰撞信息，并据此实现交互逻辑或特效放置。
  • Rect: Rect 表示二维平面上的轴对齐矩形区域，由最小角点和最大角点定义边界，并提供 Width、Height 读取区域尺寸。
  • Region3: Region3 表示由两个 Vector3 对角点界定的轴对齐三维区域，并可按指定分辨率向外扩展到网格边界。
  • Region3int16: Region3int16 表示由两个 Vector3int16 角点界定的整数网格三维区域。
  • RemoteEvent: 远程事件用于客户端与服务端之间的异步单向通信，支持服务端向指定客户端或全部客户端发送消息，也支持客户端向服务端发送消息。通过匹配的事件名称在两端建立通道，并借助 FireServer、FireClient、FireAllClients 触发，由 OnServerEvent、OnClientEvent 接收。
  • ReserveServerResult: ReserveServerResult 承载预留服务器操作的结果数据，用于向服务端返回可进入目标服务器的访问码。通过读取 ReservedServerAccessCode 属性，可将成功预留的访问码应用到后续传送流程的选项配置中，是完成预占服务器到实际传送之间衔接的桥梁。
  • ScreenGui: ScreenGui 是当前玩家本地屏幕 UI 的快捷控制对象，用于显示飘字、游戏结果、观战控件和个人/团队积分面板。
  • Signal: Signal 是用于同端内部模块间的事件信号，支持持续监听、单次监听以及触发时向所有监听者转发参数。它提供 Connect、Once 和 Fire 方法，可实现灵活的发布订阅通信。
  • SubCustomAppearance: SubCustomAppearance 描述 CustomAppearance 中一个子模型的公开外观数据，包括模型与皮肤资源、染色区域、挂点、相对变换、材质、透明度和阴影设置。
  • TeleportAsyncResult: 传送异步结果是在调用传送服务后返回的数据载体，用于封装预留服务器战场实例的访问码等信息。它由传送流程自动生成，本身不可被开发者主动构造，仅作为只读结果供上层逻辑读取关键字段。
  • TeleportOptions: TeleportOptions 用于配置玩家跨服务器传送时的行为参数，可指定是否预留新服务器、目标实例标识以及携带的自定义数据。通过设置 ReservedServerAccessCode、ServerInstanceId 和 ShouldReserveServer 等属性，能够精确控制传送目标与方式，并利用 SetTeleportData 传递可序列化的上下文信息。
  • Timer: 计时器对象，用于在指定延迟后或按固定间隔重复执行回调函数。它由 TimerService 创建，提供启动、暂停、恢复、取消等控制能力，并可查询运行状态、间隔和剩余次数。
  • Transform: Transform 是描述三维空间位姿的变换数据，将位移（Translation，别名 Position）、以四元数表示的旋转（Rotation）与缩放（Scale）封装为一体，并可直接读取前向、上、右三个方向向量。它提供世界空间与对象空间之间的点与方向换算、变换叠加、插值、求逆、与矩阵互转，以及通过欧拉角或轴角构造变换的能力。
  • TriggerCallbackInfo: TriggerCallbackInfo 是 TriggerUnit 本地触发事件传入的只读回调数据，公开提供 OtherUnit，用于标识进入或离开触发区域的另一方单位。该类型不可直接构造。
  • TweenInfo: TweenInfo 是补间动画的配置对象，用于定义动画的持续时间、缓动风格、重复次数等参数。它通过 TweenService 创建补间时传入，控制动画的播放行为。
  • UDim: UDim 表示一维 UI 尺寸，由比例分量和像素偏移分量组成。它常用于定义界面元素的宽度或高度，允许同时按父容器比例和固定像素值来灵活布局。
  • UDim2: UDim2 表示二维 UI 的位置或尺寸，由水平方向和垂直方向的比例值与像素偏移组合而成。
  • Vector2: 二维向量用于表示平面上的位置、方向或位移，提供坐标访问、长度计算、归一化、点积、叉积、角度、线性插值等常用运算。支持逐分量取绝对值、取整、取符号以及近似相等比较。
  • Vector2int16: Vector2int16 表示由两个 16 位整数构成的二维向量，常用于网格坐标、区块索引或离散位置表示。它提供简洁的 x、y 分量读写，并支持通过 New 方法快速构造实例。
  • Vector3: 三维向量，用于表示位置、方向、速度或缩放等三维量。提供向量运算方法，如点积、叉积、线性插值和归一化，并支持通过只读属性获取长度和单位向量。
  • Vector3int16: 三维整数向量，使用 16 位整数存储 X、Y、Z 分量。常用于表示网格坐标、区块索引或离散空间位置，确保数值为整数且范围受限于 16 位。
  • Vector4: 四维向量用于表示和操作包含四个分量的数值结构，常用于颜色、裁剪区域或齐次坐标等场景。它提供了长度计算、点积、归一化以及分量极值查询等数学运算。

返回类型索引