工坊手册

主题

类型索引 ​

共 301 个类型。

单位 Unit (103) ​

  • AmbientOcclusionEffect: 环境光遮蔽效果用于模拟物体角落和缝隙处的柔和阴影，增强场景的立体感和真实度。通过调整采样半径、深度偏移和遮蔽强度，可以控制阴影的扩散范围与浓淡程度。该效果继承自基础后处理，可启用或禁用以实时切换画面表现。
  • AngularMotorUnit: 旋转运动器是驱动场景单位持续旋转的运动组件，通过角速度属性设定旋转速度与旋转轴方向。该类型由场景创建并持有，适合用于自动转动的机关、装饰物或动态展示元素。
  • AnimatedUnit: AnimatedUnit 是可播放模型内置动画片段的场景单位，适合机关、装饰物等非角色对象；类型本身属于 common，动画播放/停止接口按函数契约在服务端调用，状态查询可用于读取当前播放状态。
  • AnimationTrack: AnimationTrack 是动画轨道对象，用于控制单个动画的播放、停止、速度与权重。它由 Animator 加载动画后返回，提供对动画时间位置、循环、骨骼过滤和优先级的精细调节，并支持在指定时间点添加标记和回调。
  • Animator: 动画控制器负责为角色单位加载动画资源、创建 AnimationTrack，并查询当前正在播放的动画轨道。
  • Attachment: Attachment 表示依附于父级单位的局部坐标锚点，通过 Position、Rotation、Orientation 与 CFrame 描述相对父级的变换，同时提供 WorldPosition、WorldRotation、WorldCFrame 等自动换算的世界空间读写入口，方便直接获取锚点在场景中的实际位置与朝向。它还可通过 Axis 与 SecondaryAxis 表达局部轴向，并借助 Visible、ShowOrientation 控制坐标轴的显示辅助。调用 GetConstraints 可以取得当前挂载在该锚点上的全部约束。
  • Backpack: 背包
  • BackpackItem: BackpackItem 是可放入背包的物品基类，提供 Icon 等背包展示所需的基础属性。Tool 等具体物品类型继承自它。
  • BallSocketConstraint: BallSocketConstraint 描述两个 Attachment 实例之间的球形关节；当前公开契约可通过 Attachment0/Attachment1 直接引用端点。
  • BaseController: BaseController 是角色控制器的基类，负责生命值、移动、跳跃和状态切换等通用行为；实例通过 HumanUnit、EggyUnit 等公开角色类型的 Controller 属性获取，基础 Unit 不声明 Controller。
  • BaseMotorUnit: 运动器基类，为各类周期性或往返运动的子类（如角速度运动器）提供统一的配置入口与控制接口。通过循环、返程、单程时间、暂停时长等属性可以编排运动节奏，并借助开始、暂停、继续、返程、停止等函数对运动过程进行实时干预。运动器还会在启动与停止时触发事件，便于外部逻辑感知状态变化。
  • BasePart: BasePart 是三维场景中兼具物理碰撞与渲染表现的组件基类，WorldUnit、PhysicsUnit、RenderUnit 等具体单位类型均继承自它。它统一了空间变换、渲染表现与装配体物理量等能力：既可通过 CFrame、Position、Rotation、Scale 控制摆放与姿态，也可通过 ModelAlpha、ModelVisible、CastShadow、ModelColor1 至 ModelColor4、SkinId 与自定义外观调整显示效果，还能读取装配体的线速度、角速度、质量与质心。同时提供网络模拟权判定与设置、焊接约束关系查询等管理接口。
  • BasePostEffect: BasePostEffect 是所有后处理特效的基类，提供统一的启用开关。它本身不可直接创建，必须通过其子类（如 BloomEffect、ColorGradingEffect 等）来使用，并挂载到 LightingService 下才能生效。
  • BaseScript: BaseScript 是 Script、LocalScript 与 ModuleScript 的抽象基类，公开脚本源代码文本。SourceCode 可在创建具体脚本子类时作为 config 字段提供。
  • BaseSky: BaseSky 是公开天空类型的抽象基类，统一提供是否受雾影响的 AffectedByFog 属性。
  • BindableEvent: BindableEvent 是纯逻辑的本地事件容器，自身不参与渲染与物理模拟。它通过 Event 信号暴露 Connect、Once、Wait 等监听方式，配合 Fire 可携带任意数量参数触发回调，常用于模块之间或同一单位层级内部的解耦通信。事件的生命周期随实例存在，监听与触发均在本地逻辑环境中完成。
  • BloomEffect: 泛光效果用于在场景中产生高亮区域的辉光扩散，增强画面的光感与氛围。通过调整亮度阈值、强度、扩散范围和亮度缩放，可以控制泛光的触发条件和视觉表现。
  • CameraUnit: 相机单位是负责玩家视角渲染与控制的场景实例，支持通过位置、朝向、俯仰偏航滚转角度、视场角、投影模式与裁剪范围等手段精细调节画面，还能设定跟随目标与额外关注目标来驱动预设视角行为，并提供遮挡检测与相机移动重置等操作能力。
  • ClickDetector: 点击检测器是一种挂载在其他单位上的交互组件，用于捕捉玩家对目标物体的左键与右键点击操作。它通过最大激活距离控制交互生效范围，并以启用开关决定是否响应点击；在有效点击发生时，会触发对应事件并将触发玩家作为参数传出。
  • ColorGradingEffect: 色彩分级效果是一种后处理特效，用于调整场景的整体色彩风格。它支持预设滤镜、基础调色（色相、明度、饱和度、对比度）以及分区域染色（阴影、中间调、高光），可快速改变画面氛围。
  • ComicEffect: 漫画效果是一种场景后期处理滤镜，可将画面渲染为漫画风格。它通过亮部、暗部和天空颜色的着色控制，配合色阶层级量化、描边宽度与强度以及网点强度参数，模拟漫画的色块、勾线和半调网点质感。
  • ConfigSnapshot: ConfigSnapshot 是由 ConfigService 获取的不可变配置视图，可读取键值、监听单键变化，并在后台版本更新后主动刷新。
  • CurveVelMotorUnit: 曲线速度运动器是一种按预设速度曲线驱动单位运动的场景单位，通过 CurveAccelerationTime、CurveConstantSpeedTime、CurveLinearAcceleration 与 CurveAngularAcceleration 等参数，控制单位在启动后先加速、再匀速的运动过程。创建时可通过 CurveVelType 指定直线或圆周运动，并可将自身挂接到目标单位上，实现平台升降、旋转机关等可配置的运动效果。
  • DepthOfFieldEffect: DepthOfFieldEffect 是控制场景景深效果的后处理单元，通过 FocusDistance 和 MaxBlurSize 调整对焦距离与最大模糊半径；启用后需挂载到 LightingService 才能生效。
  • EUIButton: EUIButton 是 UI 按钮控件，用于在界面上创建可交互的按钮。它支持设置常态、按下和禁用三种状态的图片与颜色，并能显示文本。点击事件通过 OnClicked 订阅，可响应玩家操作。
  • EUIClippingNode: EUIClippingNode 是一个 UI 裁切节点，用于根据蒙版图片的 Alpha 通道对子节点进行裁切显示。通过设置 ClippingImage 指定蒙版资源，并利用 AlphaThreshold 控制裁切阈值，可实现圆形头像、不规则形状遮罩等效果。支持反转裁切区域，灵活控制子节点的可见范围。
  • EUIEffect: EUIEffect 是用于在 UI 中播放动效的节点，支持设置动效资源、控制播放与停止，并可配置循环播放和尺寸。
  • EUIGridLayout: EUIGridLayout 是 UI 网格布局容器，负责将子节点按网格排列。它支持设置单元格尺寸、间距、填充方向、对齐方式等属性，并通过 ApplyLayout 方法刷新布局。
  • EUIImage: EUIImage 是用于在界面中显示图片的 UI 控件，支持设置图片资源、颜色和拉伸区域。通过调整拉伸区域可以控制图片的九宫格缩放效果，适合制作按钮、图标、背景等界面元素。
  • EUIInputField: EUIInputField 是用于接收玩家文本输入的界面控件，公开属性可读取当前 Text，并描述字体、颜色、描边、阴影、对齐与占位提示等外观契约。当前运行包对 Text 与 PlaceHolderText 的直接写入仍有桥接 warning，因此可运行示例仅展示创建控件和读取 Text。
  • EUILayout: EUILayout 是一个 UI 布局容器节点，用于承载和管理其他 UI 元素。它支持开启裁切功能，当子节点超出自身边界时可将其隐藏，适合构建列表、滚动区域或需要限制显示范围的界面。
  • EUIListLayout: EUIListLayout 是 UI 列表布局容器，用于自动排列子节点。它支持设置填充方向、间距、对齐方式和排序规则，并可通过 ApplyLayout 方法刷新布局。
  • EUIListView: EUIListView 是可滚动列表容器，用于在界面中展示大量子项并支持滑动浏览。它提供背景图片与透明度设置、裁切与回弹效果控制，以及通过百分比或索引滚动到指定位置的能力。
  • EUILoadingBar: EUILoadingBar 是用于显示进度或加载状态的 UI 控件，通过设置 Percent 属性控制进度条的填充比例。它支持自定义进度条图片和颜色，并可指定填充方向。
  • EUINodeBase: 界面节点是搭建游戏界面层级的基础单位，负责管理节点的显示、坐标、锚点、尺寸、旋转、透明度等布局属性，同时支持触摸音效、触摸开关、触摸吞噬以及针对屏幕边缘的自适应规则。它还提供补间动画方法用于平滑改变位置、尺寸与透明度，并且能够通过触摸开始、移动、结束和点击等事件响应玩家操作，配合保留与释放机制维护节点引用。
  • EUIProgressTimer: EUIProgressTimer 是进度计时器控件，用于在界面上显示一个可配置颜色、图片和方向的环形进度条。通过设置 Percent 属性（0-100 的浮点数）来控制进度填充比例，并支持动态更换进度条外观。
  • EUIRichTextLabel: EUIRichTextLabel 是富文本标签控件，用于在界面中展示带样式的文本内容。它支持设置字体、颜色、描边、阴影、斜体等外观属性，并提供自动缩小字号、换行限制、溢出滚动等高级排版功能。
  • EUIRootNode: UI根节点
  • EUISceneNode: EUISceneNode 是用于把 UI 放到三维世界中的场景界面节点，可设置世界坐标，也可挂接到 Unit 的指定 socket。
  • EUISimpleRichTextLabel: 一种用于在界面层级中展示富文本内容的界面单位，可通过文本、颜色、字号、字体等属性控制显示效果，同时支持描边、阴影、斜体、对齐方式、字间距与行间距等排版设置。它还提供自动缩小字号、超框策略与爆框策略等自适应能力，适合轻量级文本展示需求。
  • EUITableLayout: EUITableLayout 是 UI 表格布局容器，负责将子 UI 节点按行或列排列成网格。它支持设置主轴方向、间距、自动布局和自动扩容，并可通过 ApplyLayout 手动刷新布局。
  • EUITextLabel: EUITextLabel 是用于在界面上显示文本的控件，支持设置文本内容、字体、大小、颜色以及描边和阴影等样式。通过调整对齐方式与斜体等属性，可以灵活控制文本在标签区域内的呈现效果。
  • EffectUnit: EffectUnit 是场景中已配置特效实例的运行时控制单位，用于调整可见性、位置、旋转、缩放、颜色、时长和绑定关系。
  • EggyController: EggyController 是 EggyUnit 的控制器组件，通过 EggyUnit.Controller 属性获取，用于触发前扑、翻滚、抓举和投掷等蛋仔角色动作。
  • EggyUnit: EggyUnit 是场景中的蛋形生物角色，可由玩家操控，也可作为怪物或 NPC。它提供空间变换、网络所有权、控制器以及蛋形外观和运行时自定义外观的接入能力。
  • FileMesh: 文件网格用于在现有渲染单元上挂载自定义网格和纹理，通过指定网格资产、纹理资产、缩放、偏移和顶点颜色来改变模型外观。它本身不参与物理模拟，仅作为视觉表现层附加到父级渲染或空间单元上。
  • FindingPathUnit: 寻路路径单元用于按顺序维护一组路径点，公开 Meta 支持添加、删除以及发起路点/数量查询。
  • Fog: 雾效用于在场景中添加大气雾和高度雾，控制雾的颜色、浓度、距离和高度范围，营造氛围或遮挡远景。通过调整散射参数，还能模拟阳光穿过雾气的效果。
  • Folder: 文件夹
  • GradientSky: 渐变天空用于在场景中创建双色渐变背景，通过起始颜色和结束颜色定义天空色调，并支持调整渐变方向、过渡位置和柔和度。它继承自基础天空类型，可受雾效影响，适合营造不同的环境氛围。
  • HingeConstraint: HingeConstraint 描述两个已绑定 Attachment 之间绕共享轴旋转的铰链约束。
  • HumanController: 人形生物控制器，是附着在人形单位上的行为控制组件，负责驱动角色移动、坐立等状态，并提供运行速度与落地速度的查询接口。它同时监听攀爬、奔跑、坠落、起身、自由落体以及坐下等状态变化事件，便于上层逻辑响应角色的行为切换。此外还可配置目标点、状态机开关、惯性以及名称显示偏移等参数。
  • HumanUnit: HumanUnit 是场景中可创建的人形生物单位，用于构建玩家角色、NPC 等需要人形外观与物理表现的对象。它提供位置、旋转、缩放、可见性等基础变换属性，以及物理模拟（质量、重力、碰撞组、力的施加）、模型外观（渲染网格、模型颜色与纹理、附加网格）和控制器/动画（Controller、Animator）等完整能力。可通过 OnCollisionEnter 与 OnCollisionExit 事件感知本地碰撞。
  • InkWashEffect: 水墨效果是一种作用于整体画面呈现的后期处理滤镜，通过描边宽度、描边强度、水墨浓度、纸张颜色和去色强度等参数，将场景渲染成类似传统水墨画的风格，适合国风、写意或特殊视觉表现的地图氛围营造。
  • LensRainEffect: 镜头雨水效果，用于在游戏画面上叠加一层雨痕与雨点的视觉特效。通过中心清晰区半径控制画面中央无雨区域的大小，雨痕组与雨点组的各项参数则分别调节雨丝滑落和雨点滴落的形态与强度。
  • LinearMotorUnit: 直线运动器（LinearMotorUnit）是场景中的直线运动驱动单位，运动器类型（MotorType）决定其运动实现方式，而直线运动的方向与速度需预先在编辑器中配置。它运行期间可借助基类提供的运动控制能力被启动、暂停或复位，适合作为驱动场景部件沿直线滑动的动力来源。
  • LinkEffectUnit: 连线特效单位，用于在两个位置之间渲染一条可视的连线效果。它既可以直接指定终点坐标，也可以将终点绑定到某个场景单位上，从而让连线跟随单位移动，常用于表现激光、牵引线、连接光束等视觉效果。
  • LocalScript: 本地运行脚本
  • ModelUnit: ModelUnit 是用于组织多个 SpaceUnit 子对象并以统一枢轴进行整体移动的模型容器。
  • ModuleScript: ModuleScript 是可被其他脚本 require 的模块脚本 Unit，继承 BaseScript 的 SourceCode 字段，用于沉淀可复用 Lua 逻辑。
  • Path: Path 对象用于保存一次寻路计算结果，提供路径点遍历、采样和射线检测等能力。通过 ComputeAsync 计算起点到终点的路径后，可读取 Status 判断是否成功，并用 GetWaypoints 获取路径点列表。不再使用时必须显式调用 Destroy 释放资源。
  • PathfindingLink: PathfindingLink 用于在导航网格的两个锚点之间建立外部连接，使寻路单位可以跨越原本无法通行的区域，例如断崖、台阶或跳跃点。通过 Attachment0 与 Attachment1 指定连接的两端，并可借助 IsBidirectional 控制是否双向通行，利用 Label 为连接标记用途。编辑器预摆放并参与烘焙的链接不会受动态导航网格开关影响，而运行时创建的链接则需要依赖动态导航网格更新机制。
  • PathfindingModifier: PathfindingModifier 用于标记父级物理单位在导航网格中的区域标签、穿越性和烘焙模式。通过设置 Label 可定义区域类型，PassThrough 控制是否允许穿越，BakeMode 决定该修饰器在导航网格烘焙时的处理方式。运行时修改这些属性需要 PathfindingService 的动态导航网格支持才能触发重烘焙。
  • PendulumMotorUnit: 摆锤运动器是一种以摆锤方式驱动对象运动的场景运动器，通过 AngularVelocity 属性设定摆动角速度，并继承 BaseMotorUnit 的完整运动控制能力，可配合 IsCycle、BackTracking、HalfCycleTime、ArrivalPauseTime、BackPauseTime 与 Duration 等参数配置循环、返程与停留时序，同时借助 OnMotorStart、OnMotorStop 事件感知运动状态变化。
  • PhysicsUnit: PhysicsUnit 是场景中承担真实物理模拟的单位，具备质量、质心、重力、阻尼等刚体属性，可配置碰撞与射线检测。它提供完整的力与冲量施加接口，能够驱动对象移动、旋转或被击飞，同时通过碰撞组和碰撞对管理单位间的交互，碰撞事件可用于实现打击、触发等玩法逻辑。
  • PixelateEffect: 像素化效果是一种后处理特效单元，用于为整个场景或视口添加马赛克般的像素块化视觉风格。通过调整像素块数量属性，可以控制画面的颗粒细腻程度，值越小单个像素块越大，画面越模糊。
  • Player: 玩家对象代表局内的一位玩家，包含唯一标识、所属阵营、玩家界面和当前操控单位等核心属性。提供玩家状态查询与交互方法，例如获取名称、VIP 状态、地图点赞与收藏状态、粉丝团信息、网络延迟，以及踢出玩家、重置角色、加载角色和好友相关操作。同时通过角色创建与移除、聊天、传送、挂机、断线等事件驱动游戏逻辑，也可作为网络消息通信的标识。
  • PresetLink: PresetLink 是预设资源链接在场景树中的标记 Unit，用于表示某个场景对象与预设资源之间的关联。
  • PresetSky: 预置天空单元，内置多套打磨好的成套天空球外观，通过 Template 属性从 PresetSkyTemplate 枚举中选择一个模板，即可一键切换星空、极光、深海等整幅天空氛围，无需手动调参。SkyboxTexture 属性提供当前背景贴图的读取入口，配合单元自身的挂接与销毁能力，适合快速为场景搭建风格统一的天空背景。
  • PrismaticConstraint: PrismaticConstraint 描述两个已绑定 Attachment 之间沿单一轴向滑动的棱柱约束。
  • QuadGradientSky: 四色渐变天空是一种通过天顶、偏上、偏下、天底四层颜色和高度定义天空渐变效果的组件。它允许调整各层颜色、高度位置以及层间过渡柔度，并支持整体旋转。常用于营造丰富的天空氛围，替代单一颜色或简单渐变。
  • RenderTriggerUnit: RenderTriggerUnit 是兼具运行时模型渲染与触发检测能力的场景单位；RenderMeshId 指定实际渲染网格，DisplayModelId 只用于编辑器预览。
  • RenderUnit: RenderUnit 是一种可在三维场景中创建的渲染组件，负责承载并展示模型资源。它提供了模型资源绑定、透明度与可见性控制、阴影投射、多区域染色、皮肤以及自定义外观等表现能力，适合用来搭建场景中的装饰物或需要独立控制渲染效果的物件。
  • RigidConstraint: RigidConstraint 描述两个 Attachment 实例之间的刚性连接；当前公开契约可通过 Attachment0/Attachment1 直接引用端点。
  • RodConstraint: RodConstraint 描述两个已绑定 Attachment 之间保持固定距离的杆约束。
  • Script: Script 是服务端脚本 Unit，继承 BaseScript 的 SourceCode 字段，用于承载只在服务器侧执行的 Lua 逻辑。
  • SeatUnit: SeatUnit 是座位外观与占用状态的接口类型。当前运行包可以创建并显示座位，但坐下交互与占用者事件尚不可依赖。
  • SimpleAreaLight: SimpleAreaLight 是矩形平面形态的装饰性自发光体；它自身呈现亮色，但不会作为真实光源照亮周围物体。
  • SimpleAreaShadowLight: SimpleAreaShadowLight 是暗调矩形自发光体，用较深颜色呈现面状装饰光效，不会向周围物体投射真实照明。
  • SimpleLight: SimpleLight 是装饰性自发光单位的抽象基类，集中定义位置、旋转、缩放、启用状态和开关事件名等共有属性。
  • SimpleLineLight: SimpleLineLight 是支持两端颜色渐变的线状装饰性自发光体；它呈现发光外观，但不会照亮周围物体。
  • SimpleLineShadowLight: SimpleLineShadowLight 是支持双色渐变的暗调线状自发光体，不会向周围物体投射真实照明。
  • SimplePointLight: SimplePointLight 是球状点形态的装饰性自发光体；它自身呈现亮色，但不会照亮周围物体。
  • SimplePointShadowLight: SimplePointShadowLight 是暗调点状自发光体，用较深颜色呈现球状装饰光效，不会照亮周围物体。
  • SimpleSpotLight: SimpleSpotLight 是锥形装饰性自发光体，可显示光束外观，但不会作为真实聚光灯照亮周围物体。
  • SimpleSpotShadowLight: SimpleSpotShadowLight 是暗调锥形自发光体，用于低亮度方向性装饰，不会照亮周围物体。
  • SkeletalSocketMount: 骨骼挂点用于在角色骨骼上定义附着位置；通过挂点名称、位移和旋转控制其子对象相对目标骨骼的姿态。
  • SketchEffect: 素描效果是一种后处理滤镜，能将场景画面渲染为手绘素描风格。它提供暗角缩放、去色强度、描边宽度与强度、笔触密度以及密集、中度、稀疏三档笔触的强度与阈值等参数，配合纸张颜色与亮度设置，可精细调节画面的笔触观感。
  • SkinUnit: SkinUnit 是挂在目标单位下的外观覆盖组件，可用 SkinId、四组染色颜色和 MaterialParam 描述要应用的皮肤外观。
  • Sky: 天空单元，负责为场景提供可定制的背景天空。它支持通过 Template 属性从 SkyTemplate 枚举中挑选现成模板，也能直接指定 SkyboxTexture 背景贴图，并允许调整 Orientation 旋转、YOffset 垂直偏移以及 DistortionEnabled、DistortionStrength、DistortionFrequency 等扰动参数来营造动态天空效果。
  • SoundGroup: SoundGroup 是音效分组容器，通过 Volume 统一控制挂在该组下的 SoundUnit 音量。
  • SoundUnit: SoundUnit 是场景中的音效播放单位，用于在指定位置播放 2D 或 3D 音频资源。通过设置 SoundId 指定音频，可调节音量、播放速率、衰减距离等参数，并支持循环播放与自动播放。提供 Play、Stop 等控制方法，以及 Played、Stopped 事件用于监听播放状态变化。
  • SpaceUnit: SpaceUnit 是三维世界中所有可放置物体的空间基类，统一提供位置、旋转与缩放相关的变换能力。它通过轴心（Pivot）读取与写入控制物体在场景中的摆放，并支持标签标记、所属玩家记录以及空间层级顶端查询等辅助功能。实际使用时通常不直接操作该基类，而是通过其具体子类（如 WorldUnit、TriggerUnit）获得继承的空间能力。
  • SpawnLocationUnit: 出生点单元用于定义玩家在场景中的初始生成位置与所属阵营。通过设置阵营编号、预设蛋仔外观和容纳上限，可以控制不同队伍的出生区域与角色外观。它还支持范围出生模式，允许玩家在指定区域内随机分布。
  • TextUnit: 三维文字组件，用于在场景中显示可配置的立体文字。支持调整位置、旋转、缩放、字体、颜色、对齐方式以及超框滚动等丰富属性，可灵活定制文字外观与布局。
  • Tool: 工具单位，代表玩家可装备、使用和丢弃的物品。它提供激活与停用方法，并通过事件通知装备、卸下、激活和停用等状态变化。
  • TriggerUnit: TriggerUnit是场景中的触发区域单位，专门用于检测其他单位的进入与离开。它允许通过碰撞组白名单或指定单位黑名单来精确控制哪些对象可以触发事件，并提供物理网格、显示模型、碰撞组等配置项。当检测到单位进入或离开时，会触发相应的本地事件，供逻辑脚本响应。
  • Tween: Tween 是用于驱动目标对象属性随时间平滑变化的补间动画对象，由 TweenService:Create() 创建。它提供 Play、Pause、Cancel 三个方法控制动画生命周期，并通过 Completed 事件在动画自然结束时通知调用方。PlaybackState 属性可随时查询当前播放状态。
  • Unit: Unit 是所有场景单位的基础类型，负责游戏对象树的层级组织与数据管理。它支持子节点的增删查、路径定位、自定义属性附加以及属性变更监听，并提供克隆、销毁等生命周期操作。
  • WaypointMotorUnit: 路径点运动器，用于驱动已在编辑器或预配置实例中设置好路线的对象沿路径运动。
  • WeldConstraint: WeldConstraint 用于描述多个对象之间的刚性连接；当前公开脚本契约只适合操作编辑器中已完成绑定的实例。
  • WorldRoot: WorldRoot
  • WorldUnit: WorldUnit 是场景中可同时承担物理模拟与渲染表现的三维实体，既可通过物理网格参与碰撞、受力与冲量计算，也能以渲染网格呈现在世界中。它提供了丰富的物理控制能力，包括设置物体类型、质量、重力、阻尼、速度等属性，以及施加力、冲量、力矩和查询指定位置速度的方法，还支持碰撞组、碰撞事件、抓举与投掷等玩法相关行为。

服务 Service (40) ​

  • AdvertisementService: AdvertisementService 是服务端广告请求服务，提供带成功/失败事件与回调数据的广告播放，以及与商业化商品奖励关联的激励视频播放。
  • AnalyticsService: 分析上报服务，负责在服务端收集玩家的业务行为数据，为数据分析和运营决策提供统一的埋点通道。它支持自定义事件、经济变动、引导漏斗、自定义漏斗、进程进度以及数据变化等多种事件模型，并可查询玩家所属的分群信息。
  • ArchiveService: 存档与成就服务，负责服务端的玩家自定义存档读写以及成就系统的进度管理。它支持按 ID 或名称存取自定义存档，也支持查询成就的目标、自动获得标志、单次性等配置，并能读取或累加成就进度、判断成就是否完成。服务还提供成就完成与奖励获得两个事件，供服务端逻辑响应对应的时刻。
  • AssetService: 资产管理服务，作为全局单例提供资产的预加载、同步加载与异步加载能力，并按数据类与单位类资源区分加载入口，同时通过加载成功与失败事件对外暴露结果，适合在资源按需获取与预热场景中使用。
  • CameraService: 负责全局摄像机管理的服务，提供当前展示相机与主控相机的访问，支持世界坐标与屏幕坐标、视口坐标的相互转换，并能将屏幕位置转换为射线，同时支持手动刷新相机以及触发摄像机震动。它还管理默认相机预设和跟随重置时的水平、俯仰朝向行为。
  • Camps: Camps 是阵营管理服务，负责提供当前地图中全部阵营的查询入口。通过它的 GetCamps 方法可以获取一个包含所有阵营的数组，再结合 Camp 类型的 GetPlayers 方法即可读取每个阵营内的玩家成员，常用于阵营归属判断、队伍配置展示等服务器逻辑。
  • CloudMusicService: 云音乐服务负责在地图中播放网易云音乐曲库内的指定歌曲，通过曲目编号即可发起播放，并支持设置起始播放位置与音量比例。同时提供一键恢复地图自身背景音乐的能力，便于在场景音乐与地图默认音频之间灵活切换。
  • CommodityService: 商业化服务，提供玩家商品与权益查询、商品面板交互、免费商品请求、消耗操作以及相关状态事件。
  • ConfigService: 服务端配置服务，用于读取地图配置快照、按玩家读取配置，并在试玩模式下设置或清理临时测试值。
  • CustomAppearanceService: CustomAppearanceService 是运行时自定义外观管理服务，用外观数据创建运行时自定义外观，并返回可写入单位 CustomAppearanceId 的 ID 字符串。
  • DataStoreService: 数据存储服务，提供玩家存档与持久化数据的存取能力。通过该服务可创建普通数据存储、全局数据存储和有序数据存储，并支持列出所有数据存储的元信息。所有数据读写操作均为异步，建议按异步调用方式在合适的协程上下文中使用。
  • EffectService: 特效服务是全局客户端服务，负责在本地播放特效，核心能力是通过 PlayLocalEffect 在指定位置、朝向和缩放下生成特效，并支持设置持续时间、循环播放与异步加载方式。它的特效资源由官方特效路径或用户自定义资源标识符引用，播放结果仅作用于当前客户端。
  • FriendShipService: 好友服务，负责在游戏内查询两名玩家之间的好友关系，并支持向指定玩家发起添加好友的请求。查询结果通过异步回调返回，而发起请求的接口仅提交好友申请，不负责确认申请结果。
  • Game: Game 是游戏对象树的根节点，也是脚本入口处最常使用的全局对象。它负责承载整个运行环境，既可通过 GetService 获取世界、玩家、数据等各类全局服务，也可通过 CreateUnit 创建新的单位实例，并提供加载状态查询、退出前回调与剪贴板设置等基础能力。
  • LightingService: 光照服务，负责管理场景中的环境光与主光源。它提供环境光颜色与强度、主光源颜色与强度及朝向的调节能力，并支持电影色调映射、阴影淡化与反射立方体贴图配置，用于统一和营造场景的光照氛围。
  • LogService: LogService 是全局日志服务，提供分级日志输出、自定义消息类型记录、历史记录查询、清空和实时消息事件。
  • MapData: MapData 是提供地图配置数据只读访问的全局服务，允许按分区名读取小节数据与字段，查询自定义地图键值，并获取单位与资产资源的配置表。它负责把编辑器里配置的地图数据在运行时交付给逻辑脚本，配合 HasSectionData 可先判断分区是否存在再安全读取。
  • MemoryStoreService: 内存存储服务是服务端专用的高速数据存储方案，提供有序映射、队列和哈希映射三种集合类型。通过该服务可获取对应集合的句柄，进而执行数据的增删改查及原子更新操作。
  • MessageService: MessageService 提供跨服务器实时消息发布与订阅能力，通过主题隔离不同消息流。开发者可调用 PublishAsync 向指定主题发送消息，或通过 SubscribeAsync 监听主题并处理回调。消息传递为尽力而为，不保证可靠送达。
  • PathfindingService: PathfindingService 是面向场景中自动寻路角色的全局寻路服务，负责确认当前地图是否存在可用的静态或动态导航网格，并通过 CreatePath 创建后续用于路径计算的寻路对象。该服务本身不直接给出路线上的点，而是把寻路对象交给调用方，由对象上的路径计算流程生成可移动的路点。
  • PhysicsService: PhysicsService 提供空间查询与碰撞组管理能力：可执行射线、方块、球体、形状和重叠范围查询，也可注册碰撞组并配置组间碰撞关系。空间查询按公开的 common Realm 使用；碰撞组注册和关系变更由服务端权威配置。
  • Players: 玩家服务，负责管理当前对局中的所有玩家对象，是获取玩家列表、按用户编号查找玩家、根据角色反查玩家的统一入口；同时提供玩家加入与离开事件，并在客户端暴露本地玩家属性，便于访问玩家自身的界面与信息。
  • ProfileService: ProfileService 提供 Print、Warn 与 Error 三种级别的运行时日志输出，用于记录诊断信息。
  • ReplicatedFirst: ReplicatedFirst 是优先复制服务容器，其子单位会在客户端加入时优先复制，适合放置加载初期需要访问的关键资源。
  • ReplicatedStorage: ReplicatedStorage 是服务端与客户端共享的复制容器，其子单位会自动同步到客户端，但不会创建物理刚体或渲染模型。
  • RunService: RunService 是引擎运行时服务，负责提供帧循环各阶段的时序事件，并用于判断当前代码所处的运行环境（客户端、服务端或编辑器试玩）。通过它可以在每帧更新逻辑、监听物理模拟前后回调，以及根据 IsClient/IsServer/IsStudio 分流不同端的代码。
  • SceneGui: 场景界面服务负责管理以三维世界坐标为基准的界面系统，可在一个世界坐标点生成界面节点，也可把界面节点挂接到具体单位并令其随单位显示。它还向外暴露场景专用的 EuiManager，方便统一检索和操作场景界面树。由它创建的节点本质上是容器，需要填充 EUI 控件后才具备可见外观。
  • SocialService: 社交服务，作为好友邀请、分享等社交玩法的基础入口，当前向开发者公开的核心能力是基于队伍 ID 查询队员信息：既支持异步获取队伍的结构化信息，也支持同步取得队伍下的玩家对象列表，便于实现组队联动等场景。
  • SoundService: 声音服务是全局音频管理接口，负责播放二维、三维和本地音效，并支持音量分组控制。通过该服务可以创建并返回 SoundUnit 实例，进而对播放中的音频进行实时调节。
  • StarterGui: StarterGui 是管理核心 UI 界面显示与交互的全局服务，负责控制官方内置 UI 元素的启用状态，并提供对通用核心 UI 参数的读写能力。通过该服务，开发者可以按需隐藏或显示摇杆、跳跃按钮等控件，也能通过字符串键存取自定义 UI 配置。
  • StoryService: 剧情对话播放服务，负责驱动地图中配置的剧情对话播放流程。提供开始、结束、跳过三个控制接口，可针对任意玩家发起剧情生命周期操作；同时暴露开始、结束、跳过三个事件，供地图逻辑订阅玩家剧情的实时状态变化。
  • TagService: TagService 是全局标签管理器，负责为 SpaceUnit 实例动态添加、移除和查询字符串标签。它支持按标签检索所有已标记的 SpaceUnit，并能在标签变更时触发本地事件通知。
  • Task: Task 服务提供协程调度与延迟执行能力，可将函数安排到下一帧、延迟指定秒数后运行，或让当前协程挂起等待。通过 Spawn、Defer、Delay 和 Wait 等函数，开发者能灵活控制代码的执行时机与顺序，并支持取消已调度的任务。
  • TeleportService: TeleportService 负责处理玩家的跨地图传送流程，提供普通传送、预约服务器、匹配内传送与更换服务器等能力。它同时暴露了传送初始化失败事件，便于在传送未能启动时获取错误信息与相关上下文。
  • TextChatService: TextChatService 管理游戏内文字聊天频道、玩家进出频道、消息发送以及聊天界面的显隐控制。
  • TimerService: TimerService 是全局计时器管理服务，负责创建和配置游戏中的定时任务。通过它可生成一次性延迟、循环重复或手动控制的 Timer 对象，用于驱动周期性逻辑或延时回调。
  • TweenService: 补间动画服务，负责根据配置生成属性渐变动画。通过传入单位实例、补间信息和目标属性表，创建出可独立控制的补间对象，实现平滑过渡效果。
  • UserInputService: 负责在客户端统一收集与派发各类玩家输入的全局服务。它既提供键盘、鼠标、触摸与虚拟摇杆状态查询等能力，也派发从按下、变化到结束时输入的完整事件，并为蛋仔玩法中的跳跃、冲撞、翻滚、举高等专属操作提供独立事件接口，便于玩法界面在不同时机响应玩家动作。
  • VibrationService: 设备震动服务，用于向指定玩家发送震动反馈指令。通过服务端调用可控制目标玩家设备产生震动，支持自定义震动类型、次数与间隔，实现伤害受击、操作反馈等场景的触感提示。
  • World: World 是 3D 世界的宿主服务，负责容纳所有存在于场景中的单位对象，例如 WorldUnit、ModelUnit、EffectUnit 等。当这些单位作为 World 的后代时，它们处于活跃状态：具有物理属性的单位会被渲染、参与物理模拟并与其他单位及世界交互；脱离 World 层级的对象不会被渲染，也不会参与物理计算，直到重新挂载到 World 树中。World 还承担创建单位、加载资源、提供服务器时间以及响应自定义事件等职责。

数据 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: 四维向量用于表示和操作包含四个分量的数值结构，常用于颜色、裁剪区域或齐次坐标等场景。它提供了长度计算、点积、归一化以及分量极值查询等数学运算。

枚举 Enum (66) ​

  • AccessoryBindType: 该枚举表示蛋仔配饰的挂接部位，用于确定配饰佩戴在蛋仔身上的具体位置，涵盖头部、腰部和背部三种挂点。在装扮相关逻辑中，通过该枚举可以统一描述配饰的佩戴位置，并据此进行展示或挂载处理。
  • ActivePayerStatus: ActivePayerStatus 枚举表示平台定义的玩家付费活跃度分层。
  • ActuatorRelativeTo: ActuatorRelativeTo 枚举定义执行器参考坐标系的三种语义：Attachment0、Attachment1 与 World。
  • ActuatorType: ActuatorType 枚举定义了物理约束的驱动方式，用于指定马达或伺服机构的行为模式。它包含三种成员：None 表示无驱动，Motor 表示以恒定速度驱动，Servo 表示以目标位置驱动。
  • AnimationFilterType: AnimationFilterType 枚举用于限定动画影响的身体部位，可分别选择头部、躯干、左臂、右臂、左腿或右腿。
  • AnimationPriority: AnimationPriority 枚举定义了动画轨道的播放覆盖顺序，用于控制多个动画同时播放时哪个动画的姿势优先显示。开发者可用的优先级从低到高依次为 Idle、Movement、Action、Action2、Action3、Action4，其中 Action4 是最高优先级，会覆盖所有低优先级动画；Core 是引擎内部保留的最低优先级，供默认动画兜底使用，开发者不应主动设置。
  • AssetPermission: AssetPermission 枚举表示从不可用、无访问权到拥有资产的权限等级。
  • AxisType: AxisType 枚举表示 RIGHT、UP 与 FORWARD 三个标准轴向。
  • BakeMode: BakeMode 是寻路烘焙模式枚举，用于控制 PathfindingModifier 对导航网格烘焙的参与方式。它提供 Auto、Force、Ignore、Disable 四种模式，便于按区域决定是否自动烘焙、强制烘焙、忽略或禁用导航烘焙。
  • BodyType: BodyType 枚举定义物理刚体的运动行为：None 不参与物理模拟，Static 为固定碰撞体，Kinematic 由脚本驱动位置，Dynamic 完全由物理引擎模拟。
  • CameraMode: CameraMode 枚举定义了相机单元的行为模式，用于控制相机如何跟随或观察场景中的目标。通过设置 CameraUnit 的 Mode 属性为不同枚举值，可以切换相机的跟踪方式，例如绑定到角色、自由脚本控制或固定视角。
  • CameraProjection: 相机投影方式枚举定义了摄像机将三维场景投射到二维屏幕时采用的投影模型。透视投影模拟人眼近大远小的视觉效果，正交投影则保持物体尺寸不随距离变化，常用于二维界面或等距视角。
  • CameraShakeCurve: 相机震动曲线枚举定义了相机震动时使用的波形类型，用于控制震动的节奏和强度变化模式。它提供正弦波和噪声两种曲线，分别产生平滑周期震动和随机不规则震动效果。
  • CameraShakeType: 相机震动类型枚举定义了相机震动时可用的不同运动模式，用于控制震动效果的表现形式。它提供了前后移动、上下移动和旋转三种震动方式，供开发者在调用相机震动接口时选择。
  • CameraType: CameraType 枚举定义 CameraUnit 的镜头行为类型，包括固定、附着、注视、追踪、跟随、自定义、脚本控制与环绕模式。
  • CampRelationType: CampRelationType 枚举定义阵营关系标签，用于表达自身、敌对、友好、中立、除自身外全部和全部阵营等筛选语义。
  • ChatStyle: ChatStyle 枚举定义当前客户端聊天 UI 的经典面板与头顶气泡显示组合。
  • ColorGradingFilter: 色彩分级滤镜枚举定义了可应用于 ColorGradingEffect 的预设色彩风格，如复古、黑白、冷暖色调等。通过设置 Filter 属性为枚举成员，可快速切换画面的整体色彩氛围，配合 FilterStrength 调整强度。
  • ConstraintType: ConstraintType 枚举列出 Spring、Hinge、BallAndSocket、Fixed、Slider、D6、Weld 与 Rod 等约束类别。
  • ConsumptionMode: ConsumptionMode 枚举定义商品或资源的消耗策略，用于区分永久拥有、按数量扣减和按时间限制三类模式。
  • ControllerStateType: ControllerStateType 枚举定义了角色控制器可能处于的各种行为状态，如待机、移动、跳跃、攀爬、死亡等。通过监听控制器的状态变化事件，可以在不同状态间切换时触发对应的游戏逻辑。
  • CoreGuiType: CoreGuiType 枚举定义了可控制显示或隐藏的核心界面控件类型，包括摇杆、跳跃按钮、冲刺按钮、翻滚按钮、举人按钮、战斗按钮、重置按钮、聊天按钮、表情按钮、玩家列表、生命值、背包、聊天框、顶部栏容器、退出菜单、控制栏和表情菜单。通过该枚举，开发者可以精确管理玩家界面上特定控件的可见性。
  • DataStoreErrorCode: DataStoreErrorCode 枚举定义 DataStore 与 OrderedDataStore 相关操作可能涉及的数据存储错误状态，例如参数非法、请求限流、存储不存在、版本无效等。
  • DataStoreType: DataStoreType 枚举用于标识数据存储集合类型，包括普通数据存储、有序数据存储和全局数据存储。
  • DefaultCameraPresetType: DefaultCameraPresetType 枚举定义 CameraService.DefaultCameraPreset 可使用的默认相机预设。
  • DevCameraOcclusionMode: DevCameraOcclusionMode 枚举定义了相机在遇到遮挡物时的处理策略。它提供了三种模式：Zoom 表示拉近相机距离以避免遮挡，Invisicam 表示使遮挡物透明化，EggyHybrid 表示混合使用前两种策略。开发者可通过 CameraUnit 的 DevCameraOcclusionMode 属性来切换这些模式。
  • DevTouchMovementMode: DevTouchMovementMode 是移动端触摸移动模式枚举，用于配置玩家在触屏设备上的虚拟摇杆行为。通过 Enums.DevTouchMovementMode 引用其成员，可设置固定摇杆、动态摇杆或跟随用户偏好等模式。
  • DisplayDistanceType: DisplayDistanceType 枚举控制生物头顶名字与血条的显示距离判定方式。它提供三种模式：不显示、按观察者距离显示、按被观察者距离显示，用于灵活适配不同视角下的信息可见性。
  • EasingDirection: EasingDirection 枚举定义缓动曲线在补间时间轴上的作用阶段：In 表示缓动效果主要作用于开始阶段，Out 表示作用于结束阶段，InOut 表示两端都应用，OutIn 表示先按 Out 再按 In 组合。
  • EasingStyle: EasingStyle 定义了动画缓动曲线类型，用于控制补间动画在时间进程中的速度变化模式。它提供了从线性匀速到弹性、弹跳等多种预设曲线，让开发者可以精细调整动画的加速与减速效果。
  • EffectBindType: 特效绑定类型枚举定义了特效挂载到目标对象时的空间变换方式。它控制特效是否跟随目标的位置、旋转或缩放，从而影响特效在场景中的表现形态。
  • FaceStatus: FaceStatus 枚举定义蛋仔角色可播放的动态表情状态，包含开心、伤心、生气、思考、震惊、大笑、说话等常见表情。
  • FashionPartType: 蛋仔散件时装的部位类型枚举，用于区分头部、上半身与下半身三个换装部位。它配合蛋仔外观接口实现按部位设置或读取时装，也用于按部位重置外观。
  • FieldOfViewMode: FieldOfViewMode 枚举定义了摄像机视场角的计算基准，决定视野范围以哪个轴向为准。它提供 Vertical、Diagonal 和 MaxAxis 三种模式，用于控制画面中可见区域的宽窄。
  • GradientSkyDirection: 渐变天空渐变轴向枚举，用于控制 GradientSky 组件中颜色渐变的方向。它提供 X 轴和 Y 轴两个选项，分别对应水平渐变和垂直渐变，从而改变天空背景的视觉效果。
  • HorizontalAlignmentType: HorizontalAlignmentType 枚举定义 TextUnit 文本的左对齐、居中和右对齐方式。
  • HpBarShowMode: HpBarShowMode 枚举控制角色头顶血条的显示策略，支持始终隐藏、始终显示或仅在生命值不满时显示三种模式。通过 BaseController 的 HPBarShowMode 属性设置，可灵活适配不同游戏场景的 UI 需求。
  • HumanMeshColor: HumanMeshColor 枚举标识人形模型或蒙皮的染色区域，公开成员 COLOR1 至 COLOR4 分别对应四个材质染色槽。
  • KeyCode: KeyCode 枚举定义了键盘、鼠标等输入设备的按键标识符，用于在输入事件中判断具体按下了哪个键。通过 Enums.KeyCode 命名空间引用成员，可配合 UserInputService 的输入事件获取当前按键信息。
  • MemoryStoreErrorCode: MemoryStoreErrorCode 枚举定义 MemoryStore 数据结构操作可能涉及的错误状态，例如未发布作品不可用、客户端非法访问、请求限流、容量超限、键不存在或更新条件不满足等。
  • MessageType: 日志消息类型枚举，用于区分日志输出的严重程度或类别。它定义了四种标准消息类型：普通输出、信息、警告和错误，供日志系统在记录和过滤时使用。
  • MouseBehavior: 鼠标行为枚举，用于设定鼠标光标在屏幕上的工作方式，例如是否锁定到屏幕中心或保持默认自由移动。它配合用户输入服务中的相关接口使用，以便切换不同的鼠标控制模式。
  • NetworkOwnerChangeType: NetworkOwnerChangeType 枚举定义网络所有权策略值，用于表达物理对象由系统自动处理所有权，或由脚本按业务逻辑手动处理。
  • PathStatus: 路径计算状态枚举，用于表示寻路请求的最终结果。包含成功和无路径两种状态，帮助开发者判断路径是否有效。
  • PathWaypointAction: PathWaypointAction 枚举定义了寻路路径点上的行为类型，用于标记角色到达该点后应执行的动作。它包含 Walk（行走）、Jump（跳跃）和 Custom（自定义）三种选项，供寻路系统在生成路径时使用。
  • PlayerPlatformSpenderStatus: PlayerPlatformSpenderStatus 枚举表示平台定义的玩家跨平台消费状态分类。
  • PresetLinkStatus: 预设链接状态枚举用于表示预设资源链接的同步状态，帮助判断本地预设是否与源资源保持一致。它提供了四种状态：已是最新、本地已修改、有新版本可用、以及同时存在本地修改和新版本。
  • PresetSkyTemplate: PresetSkyTemplate 枚举定义 PresetSky.Template 可使用的固定天空模板。
  • RaycastFilterType: 射线过滤类型枚举用于控制射线检测或重叠检测时，如何对待传入的实例列表。Exclude 表示跳过列表中的实例，Include 表示仅检测列表中的实例。
  • SkeletalSocketType: SkeletalSocketType 枚举定义蛋仔外观挂接可用的标准骨骼挂点，如 Head、Spine、LHand、RHand 等。
  • SkyTemplate: 天空模板枚举定义了引擎内置的天空视觉效果预设，每个成员代表一种完整的天空外观方案。通过将枚举值赋给 Sky 对象的 Template 属性，可以快速切换场景的天空氛围，无需手动调整多个参数。
  • SortDirection: SortDirection 枚举定义 MemoryStoreSortedMap 范围查询的排序方向，Ascending 表示按排序键升序返回，Descending 表示按排序键降序返回。
  • TableMajorAxis: TableMajorAxis 枚举用于指定表格布局的主轴方向，决定子元素按行优先还是列优先排列。它直接影响 EUITableLayout 等 UI 组件的自动布局行为。
  • TeleportErrcode: TeleportErrcode 枚举定义传送初始化失败或传送结果通知中可能出现的错误码，用于区分成功、失败、地图不存在、服务器已满、权限不足、请求过频、超时等状态。
  • TeleportState: 传送状态枚举描述了玩家在跨服务器传送过程中所处的各个阶段。它覆盖了从发起请求到最终完成或失败的完整生命周期，帮助开发者在不同阶段执行对应的逻辑处理。
  • TextChatChannelType: TextChatChannelType 枚举定义文字聊天的官方频道类型，目前包含全体频道与阵营频道两类。
  • TextFontType: TextFontType 枚举定义了文本组件可用的字体样式，包含黑体、圆体、标宋、魏碑等多种中文字体。通过设置 TextUnit 的 FontName 属性或 EUITextLabel/EUIRichTextLabel/EUIInputField 的 Font 属性，可以切换文本的显示字体。
  • TextOverflowStrategy: TextOverflowStrategy 枚举定义了文本内容超出显示区域时的三种处理策略。它允许开发者选择不处理溢出、直接截断超出部分，或启用跑马灯滚动效果来完整展示长文本。该枚举通常与 TextUnit 的 OverflowStrategy 属性配合使用，以控制文本的溢出行为。
  • ThumbnailSize: ThumbnailSize 枚举表示 Players:GetUserThumbnailAsync 的名义头像尺寸规格，成员名覆盖 48x48 至 720x720。
  • ThumbnailType: ThumbnailType 枚举定义 Players:GetUserThumbnailAsync 可请求的头像缩略图类型。
  • TweenPlayState: TweenPlayState 枚举定义 Tween.PlaybackState 属性可能返回的播放阶段，包括 Begin、Delayed、Playing、Paused、Completed 和 Cancelled。
  • TweenStatus: TweenStatus 枚举表示 EUI 节点补间动画的结束状态，用于区分补间是正常播放完成还是被同通道的新补间抢占取消。
  • UserInputState: UserInputState 枚举描述用户输入事件的生命周期阶段，包括开始、变化、结束、取消和未知状态。它用于在输入处理流程中标识当前输入动作所处的具体阶段，帮助开发者精确响应不同类型的输入变化。
  • UserInputType: UserInputType 枚举定义了用户输入设备的类型，用于区分鼠标、键盘、触屏、手柄等不同输入来源。在输入事件中，通过该枚举可以判断当前操作由哪种设备触发，从而针对不同设备实现差异化的交互逻辑。
  • VerticalAlignmentType: VerticalAlignmentType 枚举定义 TextUnit 文本的顶部、居中和底部对齐方式。
  • WhenUserFirstPlayed: WhenUserFirstPlayed 枚举表示玩家首次进入游戏的时间段划分，用于区分新老玩家群体。它提供了一组预定义的区间值，如 Unknown、Days0To30、Days31To90 等，帮助开发者根据玩家注册时长进行差异化处理。