工坊手册

主题

类型索引 ​

共 327 个类型。

单位 Unit (107) ​

  • AmbientOcclusionEffect: 环境光遮蔽效果用于模拟物体角落和缝隙处的柔和阴影，增强场景的立体感和真实度。通过调整采样半径、深度偏移和遮蔽强度，可以控制阴影的扩散范围与浓淡程度。该效果继承自基础后处理，可启用或禁用以实时切换画面表现。
  • AngularMotorUnit: 旋转运动器，用于让绑定的对象按设定的角速度持续自转。它通过 AngularVelocity 指定旋转的方向与快慢，并沿用运动器基类提供的循环与时序配置能力，如 IsCycle、HalfCycleTime、ArrivalPauseTime、BackPauseTime、Duration 等。运行过程中可通过 IsActive 判断是否处于运动状态，借助 OnMotorStart 与 OnMotorStop 事件感知启动和停止。
  • AnimatedUnit: AnimatedUnit 是可播放模型内置动画片段的场景单位，适合机关、装饰物等非角色对象；类型本身属于 common，动画播放/停止接口在服务端调用时同步所有客户端，在客户端调用时仅本端生效，状态查询可用于读取当前播放状态。
  • AnimationTrack: AnimationTrack 是 Animator 加载动画后返回的轨道实例，代表某段动画的一次播放过程，负责控制该动画的播放、停止、速度与权重。它既提供 Animation、IsPlaying、Length、WeightCurrent 等只读状态用于查询播放情况，也提供 Looped、Speed、TimePosition、FilterType、Priority、WeightTarget 等可写参数用于调整播放表现。
  • Animator: 动画控制器负责为角色单位加载动画资源、创建 AnimationTrack，并查询当前正在播放的动画轨道。
  • Attachment: Attachment 是依附在某个父级 Unit 上的局部坐标锚点，用局部的 Position、Rotation、Orientation 与 CFrame 描述相对父级的变换，同时提供会随父级世界变换自动换算的 WorldPosition、WorldRotation 与 WorldCFrame 世界空间属性。它还能通过 Axis 与 SecondaryAxis 描述主副轴方向、用 Visible 控制锚点自身可见性，并可借助 GetConstraints 查询挂在锚点上的约束。
  • Backpack: 背包
  • BackpackItem: BackpackItem 是可放入背包的物品基类，提供 Icon 等背包展示所需的基础属性。Tool 等具体物品类型继承自它。
  • BallSocketConstraint: BallSocketConstraint 描述两个 Attachment 实例之间的球形关节；当前公开契约可通过 Attachment0/Attachment1 直接引用端点。
  • BaseController: BaseController 是角色控制器的基类，负责生命值、移动、跳跃和状态切换等通用行为；实例通过 HumanUnit、EggyUnit 等公开角色类型的 Controller 属性获取，基础 Unit 不声明 Controller。
  • BaseMotorUnit: 运动器基类，为各类周期性或往返运动的子类（如角速度运动器）提供统一的配置入口与控制接口。通过循环、返程、单程时间、暂停时长等属性可以编排运动节奏，并借助开始、暂停、继续、返程、停止等函数对运动过程进行实时干预。运动器还会在启动与停止时触发事件，便于外部逻辑感知状态变化。
  • BasePart: BasePart 是场景中所有具备碰撞与渲染表现的 3D 部件共享的基类，WorldUnit、PhysicsUnit、RenderUnit 等都从它继承这套公共能力。它同时覆盖三个层面：用 CFrame、Position、Rotation、Size、PivotOffset 描述空间形态，用 ModelAlpha、ModelVisible、ModelColor1 至 ModelColor4、SkinId 控制外观，用 AssemblyLinearVelocity、AssemblyAngularVelocity、AssemblyMass 观察装配体力学状态，并附带网络所有权与焊接关系的查询接口。
  • BasePostEffect: BasePostEffect 是所有后处理特效的基类，提供统一的启用开关。它本身不可直接创建，必须通过其子类（如 BloomEffect、ColorGradingEffect 等）来使用，并挂载到 LightingService 下才能生效。
  • BaseScript: BaseScript 是 Script、LocalScript 与 ModuleScript 的抽象基类，公开脚本源代码文本。SourceCode 可在创建具体脚本子类时作为 config 字段提供。
  • BaseSky: BaseSky 是公开天空类型的抽象基类，统一提供是否受雾影响的 AffectedByFog 属性。
  • BindableEvent: BindableEvent 是同端脚本之间的事件容器，通过 Connect 或 Once 监听，并通过 Fire 传递一个可选事件参数。
  • BloomEffect: 泛光效果用于在场景中产生高亮区域的辉光扩散，增强画面的光感与氛围。通过调整亮度阈值、强度、扩散范围和亮度缩放，可以控制泛光的触发条件和视觉表现。
  • CameraUnit: CameraUnit 描述渲染视角自身的状态，涵盖位置与四元数朝向、俯仰偏航滚转角度、视场角与视场角模式、近裁剪面与裁剪范围、跟随目标与额外关注目标等属性。它通过 Priority 与 IsActive 参与活跃相机的选择，通过 Mode 与 CameraType 决定行为方式，并可借助 GetPartsObscuringTarget 查出挡在目标前方的场景单位、用 ResetMovement 复位相机移动状态。
  • CelestialBody: 天体类型用于构建太阳、月亮这类悬挂在天空中的发光体，可同时存在多个互相独立的天体实例。它通过颜色、亮度与角大小控制光斑观感，并支持指定贴图，还能用旋转与跟随光照朝向来调整天体在天空中的位置表现；受雾影响开关则决定它是否被场景雾效遮蔽。
  • ClickDetector: 点击检测器是一个可挂载到其他单位上的交互组件，用 MaxActivationDistance 控制玩家能够触发点击的有效范围，用 Enabled 控制该检测器是否整体生效。当玩家在范围内点击所挂载的单位时，它会派发 MouseClick 与 RightMouseClick 事件，并在回调中把触发交互的玩家对象传给监听方。
  • Clouds: Clouds 用于在场景中生成并调控云层天空效果，可设置云的颜色、密度、移动速度与覆盖率，还能通过受雾影响开关决定云层是否随雾效变化。组合这些属性可以呈现从稀疏少云到厚实满云等不同天空氛围。
  • ColorGradingEffect: 色彩分级效果是一种后处理特效，用于调整场景的整体色彩风格。它支持预设滤镜、基础调色（色相、明度、饱和度、对比度）以及分区域染色（阴影、中间调、高光），可快速改变画面氛围。
  • ComicEffect: 漫画效果是一种场景后期处理滤镜，可将画面渲染为漫画风格。它通过亮部、暗部和天空颜色的着色控制，配合色阶层级量化、描边宽度与强度以及网点强度参数，模拟漫画的色块、勾线和半调网点质感。
  • ConfigSnapshot: ConfigSnapshot 是由 ConfigService 获取的不可变配置视图，可读取键值、监听单键变化，并在后台版本更新后主动刷新。
  • CurveVelMotorUnit: 曲线速度运动器用于按“先加速、后匀速”的节奏驱动单位运动，通过 CurveAccelerationTime 描述加速阶段的时长，通过 CurveConstantSpeedTime 描述匀速阶段的时长。直线方向的加速度由 CurveLinearAcceleration 给出，旋转方向的加速度由 CurveAngularAcceleration 给出，CurveVelType 标记当前的运动类型。把它挂到目标单位下，就能用一组参数完整描述一段带加速度变化的持续运动。
  • DepthOfFieldEffect: DepthOfFieldEffect 是控制场景景深效果的后处理单元，通过 FocusDistance 和 MaxBlurSize 调整对焦距离与最大模糊半径；启用后需挂载到 LightingService 才能生效。
  • EUIButton: EUIButton 是场景界面中的按钮控件，负责在常态、按下与禁用三种状态下分别呈现图片与配色，并支持按钮文本、字体、字号与文字颜色配置。通过 Disabled 属性可以控制按钮是否处于禁用状态，StretchArea 与 StretchAreaPercentEnabled 用于指定图片的拉伸区域及其是否按百分比计算。点击交互以 OnClicked 事件的形式对外提供。
  • EUIClippingNode: EUIClippingNode 是按蒙版形状裁剪子界面内容的 UI 节点。通过 ClippingImage 指定蒙版资源，AlphaThreshold 设定透明度阈值，Inverted 反转裁剪区域，ClippingEnabled 控制是否启用裁剪。
  • EUIEffect: EUIEffect 是用于在界面上播放动效的单位类型，动效资源由 EffectId 指定，显示尺寸由 Size 控制，LoopPlay 决定是否循环播放。它提供 PlayAnimation 与 StopAnimation 两个方法用于启动和停止动效，适合承担界面装饰、状态反馈等视觉表现。
  • EUIGridLayout: EUIGridLayout 是用于把子节点按网格形式排布的界面布局容器，可配置填充方向、单元尺寸与单元间距、主轴最大单元数、起始角落、排序依据以及水平与垂直对齐方式，并通过自动扩容属性决定容器是否随内容变化调整自身。布局参数发生变化后需要调用 ApplyLayout 让容器重新计算并刷新子节点位置。
  • EUIImage: EUIImage 是运行在玩家界面上的图片控件，用于把一张图片资源绘制到 EUI 层级中。它通过 Image 指定图片、Color 设置整体染色，并用 StretchArea 与 StretchAreaPercentEnabled 定义拉伸区域，使图片在尺寸变化时按指定区域伸缩。
  • EUIInputField: EUIInputField 是用于接收玩家文本输入的界面控件，公开属性可读取当前 Text，并描述字体、颜色、描边、阴影、对齐与占位提示等外观契约。当前运行包对 Text 与 PlaceHolderText 的直接写入仍有桥接 warning，因此可运行示例仅展示创建控件和读取 Text。
  • EUILayout: EUILayout 是界面层级中的容器节点单位，用于承载并组织其它界面节点的位置与尺寸，自身不绘制可见内容。它提供 ClippingEnabled 开关，用于决定超出容器边界的内容是否被裁切，从而让界面在有限区域内保持整洁有序。
  • EUIListLayout: 界面列表布局节点，用于把多个界面子节点按统一规则依次排列，支持设置填充方向、像素间距、水平与垂直对齐、排序依据、是否允许换行以及自动扩容。修改布局属性后需要显式刷新，才能让子节点位置按最新配置重新排列。
  • EUIListView: EUIListView 是一种可滚动列表容器，用于把界面子节点按指定方向组织成可滑动的列表区域。它提供背景图片、背景透明度、列表边距、裁切、回弹与滑动开关等属性，并通过 ScrollToPercent、ScrollToItem 与 GetScrollPercent 控制或读取滚动位置。
  • EUILoadingBar: EUILoadingBar 是挂载在玩家 EUI 树上的进度条节点，通过 Percent、Image、Direction 与 Color 控制进度数值和显示样式。
  • EUINodeBase: EUINodeBase 是 EUI 界面体系中可挂载的通用节点，负责承载界面元素的位置、尺寸、锚点、旋转、透明度、可见性、缩放以及层级与布局序号等显示状态。它同时提供触摸交互能力，包括触摸与拖动开关、触摸吞噬设置，以及触摸开始、触摸移动、触摸结束和点击的事件回调。节点还支持位移、尺寸、尺寸加位置、透明度四类补间动画，并提供引用计数式的保留与释放管理。
  • EUIProgressTimer: 环形进度条界面节点，用于在界面上以图片填充的方式展示进度比例。它通过 Percent 控制进度量、Image 指定进度图片、Direction 决定填充方向、Color 调整整体配色，适合表达技能冷却、任务进度或加载进度这类需要可视化比例的信息。
  • EUIRichTextLabel: EUIRichTextLabel 是界面层的富文本标签控件，用于在界面根节点下呈现可换行、可自适应的文字内容。它通过 Text、FontSize、Font、TextColor 组合控制文字外观，并提供描边、阴影、斜体等装饰开关。面对长文本时，还可以用 WrapWidth、WrapMaxHeight、OverflowPolicy、AutoSizeEnabled 与 MinFontSize 等属性调整排版与溢出表现。
  • EUIRootNode: UI根节点
  • EUISceneNode: EUISceneNode 是用于把 UI 放到三维世界中的场景界面节点，可设置世界坐标，也可挂接到 Unit 的指定 socket。
  • EUISimpleRichTextLabel: EUISimpleRichTextLabel 是用于界面文字展示的 UI 单位，可在同一段文本上统一控制字体、字号、颜色、描边、阴影与斜体等外观效果，并提供水平对齐、垂直对齐、字间距与行间距等排版能力。当文本超出控件范围时，它还能通过超框策略与爆框策略决定裁剪、换行或滚动方式，并可开启自动缩小字号配合最小字号限制来适配有限空间。
  • EUITableLayout: EUITableLayout 是 EUI 界面中的表格布局容器，用于把子节点按主轴方向组织成规整的行列结构。它通过 MajorAxis 决定以行还是以列为主轴，用 Padding 控制单元格间距，并可借助 FillEmptySpaceRows 与 FillEmptySpaceColumns 让行列均分剩余空间，AutomaticSize 则让容器随内容自动扩容。当需要手动控制刷新时机时，调用 ApplyLayout 重新计算并应用布局。
  • EUITextLabel: EUITextLabel 是界面层中的文本标签控件，用于在运行时向玩家呈现可动态修改的文字内容。它提供文本内容、字体与字号设置，并支持描边、阴影、斜体以及水平与垂直对齐等外观属性，还允许分别指定文字颜色、描边颜色与阴影颜色，便于呈现标题、提示或数值信息。
  • EffectUnit: 特效单位。EffectId 是特效资源标识。变换字段有特殊规则：Parent 为 BasePart/Attachment 子类时进入父跟随模式，Position/Rotation 由 Parent 驱动且不会被回写更新（读到的可能是旧值），SetPosition/SetRotation/SetScale/MoveTo 会被静默忽略，而 Scale 属性仍由自身控制、直写属性生效；设置 EffectBindData 后绑定优先于父跟随
  • EggyController: EggyController 是 EggyUnit 的控制器组件，通过 EggyUnit.Controller 属性获取，用于触发前扑、翻滚、抓举和投掷等蛋仔角色动作。
  • EggyUnit: EggyUnit 是场景中的蛋形生物角色，可由玩家操控，也可作为怪物或 NPC。它提供空间变换、网络所有权、控制器以及蛋形外观和运行时自定义外观的接入能力。
  • FileMesh: FileMesh 是用于在场景中显示自定义网格外观的单位，通过 MeshId 指定网格资产、TextureId 指定纹理资产，并可借助 Scale 与 Offset 调整网格的缩放与偏移，用 VertexColor 控制顶点着色效果。它通常作为已有渲染或空间单位的子节点存在，为宿主附加或替换可见模型。
  • FindingPathUnit: 寻路路径单元用于按顺序维护一组路径点，公开 Meta 支持添加、删除以及发起路点/数量查询。
  • Fog: 雾效用于在场景中添加大气雾和高度雾，控制雾的颜色、浓度、距离和高度范围，营造氛围或遮挡远景。通过调整散射参数，还能模拟阳光穿过雾气的效果。
  • Folder: 文件夹
  • GradientSky: 渐变天空用于在场景中创建双色渐变背景，通过起始颜色和结束颜色定义天空色调，并支持调整渐变方向、过渡位置和柔和度。它继承自基础天空类型，可受雾效影响，适合营造不同的环境氛围。
  • HingeConstraint: HingeConstraint 描述两个已绑定 Attachment 之间绕共享轴旋转的铰链约束。
  • HumanController: HumanController 是人形角色的行为控制器，负责驱动物人形单位的移动速度查询、攀爬、坐下以及人形状态机等行为。它在通用控制器能力之上补充了 ClimbEnabled、ClimbMoveDirection、SeatPart、Sit、TargetPoint、EvaluateStateMachine、InertiaEnabled、NameBarOffset 等人形专属属性，并通过 GetMoveVelocity 与 GetRelativeVelocityAtFloor 暴露速度信息，同时提供 Climbing、Running、FallingDown、GettingUp、FreeFalling、Seated、OnClimbStart、OnClimbEnd 等本地状态事件。
  • HumanUnit: 人形生物单位是场景中承载人形外观与物理表现的单位实体，既能设置位置、旋转、缩放与渲染模型，也能通过人形生物控制器驱动移动、跳跃等行为。它同时提供质量、重力、线速度、角速度、碰撞组等物理参数，以及肤色、自定义外观、按资源挂接网格并着色的外观定制能力。此外还会在本地触发碰撞进入与碰撞离开事件，便于处理接触到其他单位的反馈。
  • InkWashEffect: 水墨效果是一种作用于整体画面呈现的后期处理滤镜，通过描边宽度、描边强度、水墨浓度、纸张颜色和去色强度等参数，将场景渲染成类似传统水墨画的风格，适合国风、写意或特殊视觉表现的地图氛围营造。
  • LensRainEffect: 镜头雨水效果，用于在游戏画面上叠加一层雨痕与雨点的视觉特效。通过中心清晰区半径控制画面中央无雨区域的大小，雨痕组与雨点组的各项参数则分别调节雨丝滑落和雨点滴落的形态与强度。
  • LinearMotorUnit: LinearMotorUnit 是沿直线轨迹驱动单位运动的运动器单位，用 LinearVelocity 描述线速度、MotorType 描述运动器类型，并继承 BaseMotorUnit 的整套运动控制接口。它还可以通过 Duration、IsCycle、BackTracking、HalfCycleTime、ArrivalPauseTime 等属性刻画一次直线行程的节奏，并借助 OnMotorStart、OnMotorStop 事件反馈运动的开始与结束。
  • LinkEffectUnit: 连线特效单位用于在场景中表现自身与某个终点之间的连线效果，终点既可以用世界坐标直接指定，也可以挂接到另一个单位上随其移动。它把连线终点的两种描述方式集中在同一个单位上，方便在运行时动态切换或跟随目标。
  • LocalScript: 本地运行脚本
  • ModelUnit: ModelUnit 是用于组织多个 SpaceUnit 子对象并以统一枢轴进行整体移动的模型容器。
  • ModuleScript: ModuleScript 是可被其他脚本 require 的模块脚本 Unit，继承 BaseScript 的 SourceCode 字段，用于沉淀可复用 Lua 逻辑。
  • Path: Path 承载一次寻路计算的结果，对外暴露路径状态与路点序列。它通过 ComputeAsync 计算起点到终点之间的路线，用 GetWaypoints 读取路点，并提供 SamplePosition 采样、Raycast 检测路径沿线是否被遮挡，以及 SetAreaCost、GetAreaCost 调整区域通行代价。当路径的某一段被阻挡或重新畅通时，Blocked 与 Unblocked 事件会携带段索引通知调用方。
  • PathfindingLink: PathfindingLink 在两个 Attachment 端点之间建立导航网格之外的寻路连接。它可通过 IsBidirectional 控制是否双向通行，并用 Label 标记连接用途；运行时新增或修改的连接会在启用动态导航网格时参与重烘焙。
  • PathfindingModifier: PathfindingModifier 用于标记父级物理单位在导航网格中的区域标签、穿越性和烘焙模式。通过设置 Label 可定义区域类型，PassThrough 控制是否允许穿越，BakeMode 决定该修饰器在导航网格烘焙时的处理方式。运行时修改这些属性需要 PathfindingService 的动态导航网格支持才能触发重烘焙。
  • PendulumMotorUnit: 摆锤式运动器，用于驱动挂载的目标单位绕支点做周期性的往复摆动。它通过 AngularVelocity 指定摆动角速度，并复用基类的循环与返程时序参数来调节摆动节奏。作为运动器，它在启动后才驱动目标运动，运行过程中可以随时暂停、恢复、回退或停止。
  • PhysicsUnit: PhysicsUnit 是场景中的纯物理单位，用于承载由物理引擎驱动的刚体行为，可通过 BodyType、PhysicsActive、Mass、GravityEnabled、LinearVelocity、AngularVelocity 等属性刻画其运动状态与受力规则。它支持施加力、力矩与冲量，也支持按碰撞组和无碰撞对精细管理单位之间的碰撞关系，并通过碰撞进入与离开事件对外反馈接触结果。
  • PixelateEffect: 像素化效果是一种后处理特效单元，用于为整个场景或视口添加马赛克般的像素块化视觉风格。通过调整像素块数量属性，可以控制画面的颗粒细腻程度，值越小单个像素块越大，画面越模糊。
  • Player: Player 代表当前局内的一名玩家，带有 UserId 唯一标识、所属 Camp 以及 PlayerGui 等界面引用，也是网络消息通信所使用的标识对象。通过 Character 属性可以取得玩家当前操控的单位，并围绕角色的创建与移除提供 CharacterAdded、CharacterRemoving 等事件。它还提供 GetName、IsVip、IsMapLiked、GetPartyId、GetJoinData、GetNetworkPing 等查询接口，以及 Kick、AddFriendWith、LoadCharacterAsync、ResetCharacterToSpawnLocation 等操作接口。
  • PresetLink: PresetLink 是预设资源链接在场景树中的标记 Unit，用于表示某个场景对象与预设资源之间的关联。
  • PresetSky: 预置天空单元，内置多套打磨好的成套天空球外观，通过 Template 属性从 PresetSkyTemplate 枚举中选择一个模板，即可一键切换星空、极光、深海等整幅天空氛围，无需手动调参。SkyboxTexture 属性提供当前背景贴图的读取入口，配合单元自身的挂接与销毁能力，适合快速为场景搭建风格统一的天空背景。
  • PrismaticConstraint: PrismaticConstraint 描述两个已绑定 Attachment 之间沿单一轴向滑动的棱柱约束。
  • QuadGradientSky: 四色渐变天空通过天顶、偏上、偏下、天底四层颜色叠加生成完整的天空渐变，并用四个高度属性界定每一层颜色在天空中的分布位置，再由三段过渡柔度属性控制相邻层之间的融合程度。它还可以通过旋转属性整体调整渐变朝向，适合塑造霞光、极夜、幻境一类自定义环境氛围。
  • RenderTriggerUnit: RenderTriggerUnit 是兼具运行时模型渲染与触发检测能力的场景单位；RenderMeshId 指定实际渲染网格，DisplayModelId 只用于编辑器预览。
  • RenderUnit: RenderUnit 是可创建的 3D 渲染组件，用于在场景中显示模型，并控制整体透明度、可见性、阴影与四个染色区域。
  • 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 描述要应用的皮肤外观。编辑器中，多槽位皮肤配置与父单位的自定义外观模式互斥；父单位启用 UseCustomAppearance 时，UseSkinList 和 SkinSlots 不在属性面板显示。
  • Sky: Sky 是可完全定制的普通天空单元，用于替换或调整当前场景的天空表现。它既能通过 Template 直接套用内置天空模板，也能用 SkyboxTexture 指定背景贴图，并可通过 Orientation 与 YOffset 改变天空朝向和垂直位置，再用 DistortionEnabled、DistortionStrength、DistortionFrequency 控制天空扰动效果。实例挂载到 LightingService 后即会改变场景天空外观，移除后恢复默认天空。
  • SoundGroup: SoundGroup 是音效分组容器，通过 Volume 统一控制挂在该组下的 SoundUnit 音量。
  • SoundUnit: SoundUnit 是负责在场景中播放音频的声效单位，用 SoundId 指定音频资源，并可通过 Volume、Speed、Looped、Duration、FadeDistance、CampRoleId 等属性控制音量、播放速率、循环方式、存活时长与距离衰减。它提供 Play、Stop 两个播放控制函数，以及 SetVolume、SetSpeed、SetVolumeSpeed、SetFadeDistance、SetDuration、SetPosition 等调节函数，并借助 Played、Stopped、Ended 事件对外反馈播放状态变化。
  • SpaceUnit: 空间单位的公共基类，为所有存在于三维世界中的单位统一提供轴心变换、标签管理与空间层级查询能力。它以轴心为核心完成整体的位置与朝向调整，支持沿自身局部坐标系做相对位移，并可按名称增删与查询标签。判断对象是否处于层级顶层或向上查找顶层对象也由它负责。
  • SpawnLocationUnit: SpawnLocationUnit 用于在场景中标记出生位置，并决定该出生点的阵营归属、所属玩家以及可容纳的人数上限。它同时承担出生表现配置，包括出生时使用的预设蛋仔、渲染网格与皮肤，以及是否继承预设外观。借助范围出生开关，还可以控制出生点是否采用范围内出生的方式。
  • Stars: Stars 是用于呈现天空星点的单位。将其挂载到 LightingService 后，可通过 Color、Brightness、Density、TwinkleSpeed、Coverage 和 AffectedByFog 控制星空颜色、亮度、密度、闪烁、覆盖范围与雾效影响。
  • SurfaceGui: SurfaceGui 是把二维界面内容贴附在场景中渲染的贴面界面单元，可控制是否显示、尺寸模式、画布尺寸、像素密度与世界缩放等排版参数。它还提供受光照影响程度、亮度与最大渲染距离等显示参数，用于协调贴面界面与场景环境之间的呈现关系。
  • TextUnit: TextUnit 是可在三维场景中渲染文字内容的场景单位，用 Content 提供显示文本，并通过 FontName、FontSize、TextColor 等属性控制排版与外观。它支持 Width、Height、Scale 定义文字框尺寸，配合 LineWrap、OverflowStrategy、OverflowScrollSpeed、OverflowScrollSpacing 处理文字超出边框的情况，还能用 VerticalDirection、ReverseDirection、LineSpacing、TextSkew 调整排列与倾斜。借助 GradientColorEnable、GradientColors、GradientAngle 以及 OutlineColor、OutlineWidth，可以做出渐变与描边效果，并通过 BindSocket 依附到指定挂点。
  • Tool: 工具单位，代表玩家可装备、使用和丢弃的物品。它提供激活与停用方法，并通过事件通知装备、卸下、激活和停用等状态变化。
  • TriggerUnit: TriggerUnit 是用于检测其他单位进入或离开指定区域的触发体，可配置物理网格、缩放、空间变换以及所属碰撞组等属性。它通过碰撞组白名单与具体单位配对黑名单两种方式筛选可触发对象，并在触发发生时以本地事件的形式回调进入与离开信息。CanTouch 决定该触发体能否被其他单位触发，配合 OnTriggerEnter、OnTriggerExit、OnLocalTriggerEnter、OnLocalTriggerExit 可完整掌握区域的进出情况。
  • Tween: Tween 是补间动画的播放控制对象，用于驱动目标对象的属性在一段时间内平滑过渡到目标值。它对外暴露 PlaybackState 表示当前播放阶段、Instance 指向被动画的目标对象，并提供 Play、Pause、Cancel 三个控制函数；当播放自然结束时触发 Completed 事件并携带结束状态。
  • Unit: Unit 是所有场景单位的基础类型，通过父子关系把对象组织成一棵可遍历的层级树，并承载名称、描述、预设标识与父节点等通用信息。它提供按名称、类型或路径查找后代的能力，也能判断祖先与后代关系、统计子节点数量并按索引取子节点，同时支持自定义属性的读写与变化信号。借助克隆、销毁和子节点增删事件，可以完整地管理一个单位的生命周期。
  • WaypointMotorUnit: 路径点运动器，用于驱动已在编辑器或预配置实例中设置好路线的对象沿路径运动。
  • WeldConstraint: WeldConstraint 用于描述多个对象之间的刚性连接。可操作编辑器中已配置的约束，也可在服务端创建时通过 ConnectUnitList 与 ExpectRootUnit 配置连接对象。
  • WorldRoot: WorldRoot
  • WorldUnit: WorldUnit 是同时具备渲染显示与物理模拟能力的三维空间单元，可以配置模型资源、物理资源、碰撞开关、质量、重力、阻尼以及线速度与角速度等参数。它对外提供施加力、冲量与力矩的能力，并能通过碰撞组和互不碰撞配对来管理单元之间的碰撞关系。碰撞进入、碰撞退出以及被其他单元抓举等行为都会以事件形式向外通知。

服务 Service (41) ​

  • AdvertisementService: AdvertisementService 是服务端广告请求服务，提供带成功/失败事件与回调数据的广告播放，以及与商业化商品奖励关联的激励视频播放。
  • AnalyticsService: 数据分析与事件追踪服务，负责把玩家在游戏内产生的自定义事件、经济流水、新手引导漏斗、进阶流程与属性变更等埋点上报给分析后台，并提供玩家分群查询能力。它面向服务端使用，所有上报接口都要求传入目标 Player 实例，便于把数据归属到具体玩家。
  • ArchiveService: ArchiveService 是服务端的存档与成就服务，负责按玩家读写自定义存档数据，并管理成就的进度、目标数量、奖励与完成状态。它同时提供按名称或成就编号查询存档编号的接口，让脚本可以在自定义键值与已配置成就之间建立映射。当成就达成或奖励发放时，服务会发出本地信号，便于服务端做后续结算与提示。
  • AssetService: AssetService 是统一的资源加载服务，围绕公开资源地址提供数据类资源与单元类资源的同步、异步加载以及批量预加载能力。它既能一次性取出单个资源实例，也能把预制体、地图等资源展开为可用的单元列表，并通过加载完成与加载失败事件对外通报结果。借助批量预加载与事件回调，开发者可以在进入玩法前把贴图、音频、模型等资源提前准备好，减少运行期卡顿。
  • CameraService: CameraService 是全局相机管理服务，对外暴露当前展示相机 LiveCamera 与主控相机 MainCamera，并允许通过 DefaultCameraPreset、ResetYaw、ResetPitch 调整相机跟随行为。它提供世界坐标与屏幕坐标、视口坐标之间的双向换算能力（WorldToScreenPoint、WorldToViewportPoint），也能由屏幕或视口位置反推射线（ScreenPointToRay、ViewportPointToRay）。此外还支持 ManualRefresh 手动刷新相机状态，以及 ShakeCamera 触发指定类型、幅度、时长与曲线的相机震动。
  • Camps: Camps 是阵营查询服务，负责向脚本暴露当前场景中的阵营集合。它的核心能力是通过 GetCamps() 一次性取回全部阵营对象，并借助每个阵营的 GetPlayers() 继续枚举该阵营内的玩家。整体定位是只读的数据入口，适合在需要按阵营组织玩家信息的逻辑中作为起点。
  • CloudMusicService: 云音乐服务负责在地图中播放网易云音乐曲库内的指定歌曲，通过曲目编号即可发起播放，并支持设置起始播放位置与音量比例。同时提供一键恢复地图自身背景音乐的能力，便于在场景音乐与地图默认音频之间灵活切换。
  • CommodityService: 商业化服务，提供玩家商品与权益查询、商品面板交互、免费商品请求、消耗操作以及相关状态事件。
  • ConfigService: 服务端配置服务，用于读取地图配置快照、按玩家读取配置，并在试玩模式下设置或清理临时测试值。
  • CustomAppearanceService: CustomAppearanceService 是运行时自定义外观管理服务，用外观数据创建运行时自定义外观，并返回可写入单位 CustomAppearanceId 的 ID 字符串。
  • DataStoreService: 数据存储服务，提供玩家存档与持久化数据的存取能力。通过该服务可创建普通数据存储、全局数据存储和有序数据存储，并支持列出所有数据存储的元信息。所有数据读写操作均为异步，建议按异步调用方式在合适的协程上下文中使用。
  • EffectService: 特效服务是面向客户端本地表现的全局服务，其公开能力集中在 PlayLocalEffect 一个函数上。该函数按给定的位置、旋转与缩放播放一个本地特效，并可选地控制特效的保留时长、是否循环以及是否异步加载，调用后会返回一个句柄供后续引用。特效资源通过统一的资源标识字符串指定，因此调用方无需关心特效的内部结构即可完成播放。
  • FriendShipService: 好友服务用于在游戏内处理玩家之间的好友关系，既可以查询某个玩家与指定用户是否互为好友，也可以向指定用户发起加好友请求。查询能力以异步回调的形式返回结果，适合在玩法逻辑中实时判断好友状态。
  • Game: Game 是游戏对象树的根节点，也是全局唯一可用的顶层对象，负责承载全部服务与单位的创建入口。它通过 GetService 按名称取得全局服务，通过 CreateUnit 按类型创建场景或界面单位，并提供 IsLoaded、BindToClose、SetClipboardText、GenerateGUID 等基础能力。此外还会广播 Loaded 与 ServerRestartScheduled 两个本地事件，用于感知加载完成和服务器重启安排。
  • LightingService: 光照服务统一管理场景的整体光照表现，可以调整环境光的颜色与强度、主光源的颜色与强度及其朝向，还能开启电影色调映射、控制阴影淡化程度并指定反射立方体贴图。通过修改这些属性，可以在运行过程中平滑地改变画面氛围，例如从明亮的白昼光照过渡到偏暖的黄昏色调。
  • LogService: LogService 是全局日志服务，提供分级日志输出、自定义消息类型记录、历史记录查询、清空和实时消息事件。
  • MapData: MapData 是地图自定义数据读取服务，通过 game:GetService("MapData") 取得唯一实例，用于按字符串键查询地图作者预先配置的自定义数据。它当前只公开 GetCustomMapData 一个入口，返回值可以是任意类型的数据，当目标键不存在时返回空值，因此读取后需要先做空值判断再使用。
  • MemoryStoreService: 内存存储服务是服务端专用的高速数据存储方案，提供有序映射、队列和哈希映射三种集合类型。通过该服务可获取对应集合的句柄，进而执行数据的增删改查及原子更新操作。
  • MessageService: MessageService 提供跨服务器实时消息发布与订阅能力，通过主题隔离不同消息流。开发者可调用 PublishAsync 向指定主题发送消息，或通过 SubscribeAsync 监听主题并处理回调。消息传递为尽力而为，不保证可靠送达。
  • PathfindingService: PathfindingService 是面向场景中自动寻路角色的全局寻路服务，负责确认当前地图是否存在可用的静态或动态导航网格，并通过 CreatePath 创建后续用于路径计算的寻路对象。该服务本身不直接给出路线上的点，而是把寻路对象交给调用方，由对象上的路径计算流程生成可移动的路点。
  • PhysicsService: PhysicsService 提供空间查询与碰撞组管理能力：可执行射线、方块、球体、形状和重叠范围查询，也可注册碰撞组并配置组间碰撞关系。空间查询按公开的 common Realm 使用；碰撞组注册和关系变更由服务端权威配置。
  • Players: 玩家服务是当前对局中所有玩家对象的容器与管理入口，既可枚举全部在线玩家、按用户编号或角色单位反查目标玩家，也能在客户端直接取到本地玩家对象。它同时提供头像、头像框、昵称等资料的查询能力，并允许设定聊天样式，还通过玩家加入与离开事件驱动初始化与清理流程。
  • PrimitiveService: PrimitiveService 是客户端图元绘制的统一入口，负责创建可复用的图元句柄、按句柄绘制抛物线轨迹，并在使用结束后回收句柄资源。它通过 CreatePrimitive 返回整数句柄来标识一次绘制，DrawParabola 依据传入的配置表更新抛物线并给出是否命中及命中位置，DestroyPrimitive 则按句柄释放绘制。
  • ProfileService: ProfileService 提供分级日志、命名计时、客户端场景热力图读取，以及编辑器试玩态的 Lua CPU 火焰图和内存分配采集能力。
  • ReplicatedFirst: ReplicatedFirst 是优先复制服务容器，其子单位会在客户端加入时优先复制，适合放置加载初期需要访问的关键资源。
  • ReplicatedStorage: ReplicatedStorage 是服务端与客户端共享的复制容器，其子单位会自动同步到客户端，但不会创建物理刚体或渲染模型。
  • RunService: 运行时服务，集中提供帧循环各阶段的时序事件，包括 PreSimulation、PostSimulation、Heartbeat、FrameUpdate 与 PostFrameUpdate，每个事件都会给出本帧的时间增量。它同时提供运行环境判断能力，可区分当前代码运行在客户端、服务端还是编辑器试玩环境，方便在同一份逻辑中分流两端行为。
  • SceneGui: SceneGui 是场景界面服务，负责在三维世界坐标中创建 EUI 界面节点，或把界面节点挂接到指定单位的骨骼挂点上。它通过 EuiManager 属性对外提供 EUI 管理器，并以 CreateSceneNodeAtPosition 与 CreateSceneNodeAttachUnit 作为创建场景节点的两个入口。
  • SocialService: 社交服务，集中提供队伍信息查询与地图点赞面板弹出两类能力。它既支持按队伍标识异步读取队伍详情，也能同步取回同一队伍的玩家列表，还可主动通知指定玩家客户端弹出地图点赞面板。
  • SoundService: 声音服务是全局单例，负责在客户端发起音频播放并按音组统一管理响度。它提供二维、三维与本地三种发声入口，其中二维与三维播放会在播放的同时创建并返回一个可继续操控的 SoundUnit 实例，用于后续调整播放状态、音量与速度；音组音量则通过设置与读取接口集中维护，并在变化时对外发出通知。
  • StarterGui: StarterGui 是管理核心 UI 界面显示与交互的全局服务，负责控制官方内置 UI 元素的启用状态，并提供对通用核心 UI 参数的读写能力。通过该服务，开发者可以按需隐藏或显示摇杆、跳跃按钮等控件，也能通过字符串键存取自定义 UI 配置。
  • StoryService: 剧情对话播放服务，负责对指定玩家驱动地图中配置的剧情对话流程，提供开始播放、结束播放与跳过剧情的控制能力，并通过 OnStoryStart、OnStoryEnd、OnStorySkip 三个事件向服务端暴露剧情生命周期的变化。地图作者可以借助它在玩家触发条件时推进剧情演出，并在剧情开始、结束或跳过时衔接后续玩法逻辑。
  • TagService: TagService 是全局标签管理服务，负责给 SpaceUnit 对象附加字符串标签，并从「对象查标签」和「标签查对象」两个方向提供查询能力。它既支持用 HasTag、GetTags 查看单个对象身上的标签，也支持用 GetAllTags、GetTagged 列举已注册标签或某个标签下的对象集合。此外还提供 TagAdded 与 TagRemoved 两个本端事件，便于在标签发生变化时及时响应。
  • Task: Task 服务提供协程调度与延迟执行能力，可将函数安排到下一帧、延迟指定秒数后运行，或让当前协程挂起等待。通过 Spawn、Defer、Delay 和 Wait 等函数，开发者能灵活控制代码的执行时机与顺序，并支持取消已调度的任务。
  • TeleportService: TeleportService 负责服务端侧的跨地图传送与服务器调度：它能把一组玩家送往指定地图、预留独立的私有服务器、按匹配系统把玩家分配到对局服务器，也能让单个玩家迁移到新的服务器实例。它还提供创建传送选项的入口，并在传送初始化失败时通过事件回报失败码、错误信息与目标地图。
  • TextChatService: TextChatService 管理游戏内文字聊天频道、玩家进出频道、消息发送以及聊天界面的显隐控制。
  • TimerService: TimerService 是全局计时器管理服务，负责创建和配置游戏中的定时任务。通过它可生成一次性延迟、循环重复或手动控制的 Timer 对象，用于驱动周期性逻辑或延时回调。
  • TweenService: 补间动画服务，用于为场景中的 Unit 实例创建属性过渡动画，让位置、尺寸、透明度等可数值化的属性随时间平滑变化。调用 Create 时需要提供目标实例、TweenInfo 补间参数与目标属性表，返回值是一个 Tween 对象，后续的播放、暂停与取消都由该对象负责。它把缓动风格的配置与实例绑定的创建过程集中到同一入口，便于统一管理动画的生成。
  • UserInputService: UserInputService 是客户端输入统一入口，负责汇总键盘、鼠标、触摸与摇杆等各类输入状态，并对外派发对应的输入事件。它既能按需查询按键是否按下、鼠标位置与增量、摇杆向量等信息，也能订阅输入开始、变化、结束以及触摸点击、捏合、旋转等交互回调，还额外提供蛋仔专属按钮的点击事件。
  • VibrationService: VibrationService 是负责向指定玩家设备下发震动反馈的全局服务，核心能力是通过 StartVibration 一次性指定震动类型、震动次数与震动间隔，让目标玩家的设备按节奏产生震动。它把震动的下发集中到服务端触发，开发者无需自行处理客户端与设备之间的传递细节。
  • World: World 是三维世界的根容器，负责承载并激活所有挂载在其下的单位对象，只有在 World 树内的单位才会被渲染并参与物理交互。它提供 CreateUnit 按类型动态创建单位、CreateAsset 依据资产标识批量生成单位，以及 GetServerTime 获取统一服务器时间和 GetCustomEventSignal 订阅命名自定义事件的能力。此外，通过 AOIType2 相关半径与销毁类型属性可以控制兴趣区域的流式加载范围，CurrentCamera 则直接暴露当前使用的相机单位。

数据 Data (93) ​

  • Animation: Animation 用于封装动画资源的标识信息，将动画名称与资源 URI 绑定在一起。它作为动画数据的轻量载体，供 Animator 加载动画时使用。
  • Axes: Axes 是由名称字符串构造的轴/面布尔集合，可读取 x、y、z 与 Top、Bottom、Left、Right、Front、Back 是否启用。
  • BitMask: BitMask 是用于表示一组布尔标志的位掩码数据类型。
  • BoundingBox: 轴对齐包围盒数据结构，用最小点与最大点两个三维向量刻画一段轴对齐的空间范围。它提供获取区域中心点与三个轴向半尺寸的能力，并允许读写两端的边界点，便于在计算位置和尺寸时复用同一份数据。
  • CFrame: CFrame 用来描述三维空间中的位置与朝向，既可以表示物体在世界中的摆放，也可以表示相对某个坐标系的局部变换。它对外暴露位置分量、位置向量以及右向量、上向量、前方向量等三根基向量，并支持求逆、父子空间互转、插值、点与向量的坐标换算、欧拉角与轴角互转等运算，是摆放单位、计算朝向和做空间换算的基础载体。
  • Camp: Camp 表示游戏中的一个阵营，用于聚合同阵营的玩家并观察成员变化。通过 GetPlayers 返回的迭代器遍历当前阵营玩家，并通过 PlayerAdded、PlayerRemoved 监听成员加入或离开。
  • CollisionCallbackInfo: CollisionCallbackInfo 是 PhysicsUnit、WorldUnit 本地碰撞事件传入的回调数据，公开提供 OtherUnit，用于标识与当前单位开始或结束碰撞的另一方。该类型不可直接构造。
  • Color: Color 是 RGBA 颜色类型，用于表示带透明度的颜色值。它提供红、绿、蓝、不透明度四个分量，并支持颜色插值、分量极值比较等运算。
  • Color3: Color3 是 0 到 1 浮点分量的 RGB 颜色值，支持 RGB/HSV/十六进制构造、颜色空间转换和线性插值。
  • ColorSequence: ColorSequence 用于描述一段由关键帧组成的颜色渐变，能够在渐变区间内表达颜色随进度变化的过程。它通过 Keypoints 保存全部关键帧，并提供 New 函数完成构造，是特效、界面等需要颜色过渡的表现需求所共用的数据描述方式。
  • ColorSequenceKeypoint: 颜色序列关键帧用于定义颜色渐变序列中某一时刻的颜色值。它由时间位置和对应的颜色组成，是构建 ColorSequence 的基础元素。
  • CommodityInfo: CommodityInfo 是商品信息条目数据，用于承载商品 ID 与数量。
  • Connection: Connection 是事件订阅的句柄，代表一次有效的事件监听连接。它由 Signal:Connect() 返回，用于在不再需要时取消监听，防止内存泄漏。
  • CustomAppearance: CustomAppearance 是由主模型和若干 SubCustomAppearance 子模型组成的可复用外观数据，记录模型资源、皮肤、染色区域、材质、透明度、阴影、旋转与缩放等公开配置。
  • DataStore: 数据存储集合，用于在服务端持久化保存键值对数据，支持按键读取、写入、自增、原子更新与删除，并提供键列表遍历和历史版本查询、清理能力。它无法自行创建，只能由 DataStoreService:GetDataStore()、GetGlobalDataStore() 或 GetOrderedDataStore() 返回，是操作某一份持久化存储的入口对象。
  • 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 描述界面节点上一次触摸交互的完整过程，记录触摸开始位置 BeganPosition、触摸移动位置 MovedPosition、触摸结束位置 EndedPosition，以及用于区分不同触点的 TouchID。作者可借助它获取触点在各个阶段的坐标，从而判断拖动距离、滑动方向或多指操作。
  • EffectBindData: EffectBindData 用于描述 EffectUnit 与目标单位的绑定方式，包括宿主提供的目标单位 ID、挂点、偏移和跟随类型。
  • EggyAppearance: 蛋形生物的外观数据，用于描述蛋仔的盲盒外观、染色、时装散件、配饰、脸型、表情、肤色与蛋皮等可换装信息。它同时提供运行时换装、将外观件挂接到骨骼插槽、以及显示头顶气泡与表情等表现能力，是角色外观表现的核心数据对象。
  • Faces: Faces 是面集合数据类型，用于用面名称字符串选择 Right、Top、Back、Left、Bottom、Front 六个方向中的一个或多个面。
  • InputObject: InputObject 是输入事件与查询接口传出的输入数据，包含 KeyCode、UserInputType、UserInputState、Position、Delta 和 Processed 等 Meta 公开属性，可在事件回调中判断按键、输入类型及处理状态。
  • JoinData: JoinData 封装了玩家进入当前地图时的传送上下文信息，包括来源地图编号、一同传送的其他玩家列表以及传送时携带的自定义数据。通过 Player:GetJoinData 获取该实例后，可读取这些字段来了解玩家是如何到达当前地图的。
  • LogRecord: LogRecord 是 LogService:GetLogHistory 返回的单条历史日志记录。
  • MaterialParam: MaterialParam 是 SkinUnit 的材质参数数据，用于配置粗糙度、金属度、自发光、水体、细节纹理和边缘光等外观表现。
  • Matrix: Matrix 是描述平移、旋转与缩放复合变换的数学数据结构，同时以 Translation、Rotation、Scale 三个分量和 Right、Up、Forward 方向向量暴露内部状态，并可通过 Pitch、Yaw、Roll 读取按 ZXY 顺序解释的欧拉角。它既提供 New、Identity、Zero、FromEulerAngles 等构造与工厂入口，也提供 Inverse、GetInverse、Transpose、Apply 等运算，用来求逆、转置以及把向量送入变换后的坐标系。借助 MakeOrient、MakeRotation、MakeRotationBetween 等函数，还可以直接由方向向量或旋转轴生成朝向与旋转分量。
  • Matrix3x3: Matrix3x3 表示一个三行三列的纯数值矩阵，用来承载三维空间中的线性变换数据，例如旋转与缩放关系。它支持求转置、求逆、求行列式与迹、按行或按列提取向量、把矩阵作用于三维向量，也能产出单位矩阵、零矩阵以及叉乘对应的反对称矩阵。矩阵既可以按九个分量一次性构造，也可以由克隆或各类代数运算的结果得到。
  • 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 表示 MemoryStore 中的有序集合，条目按排序键优先、键其次的规则排列：数字排序键在最前，字符串排序键随后，没有排序键的条目排在最后。它支持用 SetAsync、GetAsync、RemoveAsync 增删改查单条数据，用 UpdateAsync 对指定键执行原子变换，借助 GetRangeAsync 按升序或降序成批读取条目，并可通过 GetSizeAsync 与 DeleteAsync 统计规模或整体清空。
  • MemoryStoreSortedMapGetRangeOptions: MemoryStoreSortedMapGetRangeOptions 是用于配置有序映射范围查询的参数字对象，通过 LowerBoundKey、UpperBoundKey、LowerBoundSortKey、UpperBoundSortKey 四个字段分别限定键与排序键的上下限。它自身不执行任何读取动作，只承载范围约束，未显式设置的字段保持默认行为。
  • 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 使用。它通过 FilterType 与 FilterDescendantsInstances 决定包含还是排除指定 Unit，通过 CollisionGroup 按碰撞组筛选，并用 MaxParts 限制返回数量。
  • Pages: Pages 是分页数据的迭代器封装，用于把体量较大的列举结果拆成多页逐步读取。它对外提供当前页内容的读取、是否已迭代完毕的状态标记，以及异步推进到下一页的操作，实例由各类列表类接口在返回值中提供，业务侧不能自行创建。
  • PathHitInfo: PathHitInfo 描述一次导航网格射线检测的命中结果，包含射线起点 StartPosition、终点 EndPosition、是否命中 IsHit，以及命中点在射线上的插值参数 HitT 和命中的世界坐标 HitPosition。它把“是否挡住去路”与“挡在何处”打包成一个结果对象，便于在寻路或落点判断时一次性读取。
  • PathWaypoint: PathWaypoint 表示寻路结果中的单个途经路点，记录该点的世界坐标位置、到达时需要执行的动作类型以及可选的自定义标签。它通常成组出现，构成一条完整的移动路径，供角色或单位按顺序行进。
  • PhysicalProperties: PhysicalProperties 描述物理材质的密度、摩擦、弹性及其混合权重，用于配置物体碰撞和接触时的物理表现。
  • PlayerGui: PlayerGui 是当前玩家的客户端 UI 入口，提供 EUIManager 和 ScreenGui 两个常用 UI 控制对象。
  • Quaternion: 四元数用 x、y、z、w 四个分量描述三维旋转，同时提供 Euler、Pitch、Yaw、Roll 等角度属性，便于在分量表示与欧拉角表示之间切换。它既能从轴角、欧拉角或直接给定分量构造旋转，也支持单位化、求逆、求共轭、点积比较与插值过渡，并可取出前、上、右方向向量或转换为 Matrix3x3。需要校验旋转数据是否可用时，可通过 IsFinite、IsUnit、IsValid 判断。
  • Ray: Ray 是一个由起点和方向向量构成的几何数据结构，用来描述从起点沿给定方向延伸的一条射线。它提供 ClosestPoint 与 Distance 两个计算接口，可求出任意空间点在射线上的最近点以及该点到射线的距离；Unit 属性则给出方向向量归一化后的射线形式。
  • RaycastParams: RaycastParams 用于封装 PhysicsService 各物理检测函数的过滤条件，通过 FilterType 与 FilterDescendantsInstances 决定检测时包含或排除哪些 Unit，并可用 CollisionGroup 与 TargetCollisionGroupList 按碰撞组进一步筛选。它把过滤规则从单次检测调用中抽离成可复用的数据对象，让射线、球体、方块与形状检测能针对不同目标切换策略。
  • RaycastResult: 射线检测结果类型，承载 PhysicsService 各投射函数命中后返回的判定信息，可读取命中对象、命中点、命中面法线与命中距离。该类型无法自行创建，未命中时投射函数会返回 nil，因此使用前必须先做判空处理再访问其属性。
  • Rect: Rect 表示二维平面上的轴对齐矩形区域，由最小角点和最大角点定义边界，并提供 Width、Height 读取区域尺寸。
  • Region3: Region3 表示由两个 Vector3 对角点界定的轴对齐三维区域，并可按指定分辨率向外扩展到网格边界。
  • Region3int16: Region3int16 表示由两个 Vector3int16 角点界定的整数网格三维区域。
  • RemoteEvent: 远程事件，承担客户端与服务端之间的异步单向通信职责。它既支持服务端通过 FireClient 向指定客户端、FireAllClients 向所有客户端推送消息，也支持客户端通过 FireServer 向服务端上报请求，接收方分别用 OnServerEvent 与 OnClientEvent 监听。
  • ReserveServerResult: ReserveServerResult 用于承载服务端预留专属服务器所返回的结果，其核心内容是 ReservedServerAccessCode 这一访问码。借助该访问码，多个玩家可以被送往同一个事先预留好的服务器实例，而不必依赖自动匹配。它通常作为传送链路的中间产物，把预留动作与后续的实际传送连接起来。
  • ScreenGui: ScreenGui 是当前玩家本地屏幕 UI 的快捷控制对象，用于显示飘字、游戏结果、观战控件和个人/团队积分面板。
  • Signal: Signal 是同端事件信号，可通过 Connect 持续监听、Once 单次监听，并用 Fire 传递一个可选参数。跨客户端与服务端的通信使用 RemoteEvent。
  • SkinSlot: SkinSlot 描述多槽位皮肤配置中的单个槽位数据，包括皮肤资源标识与四个染色区域颜色。
  • SubCustomAppearance: SubCustomAppearance 描述 CustomAppearance 中一个子模型的公开外观数据，包括模型与皮肤资源、染色区域、挂点、相对变换、材质、透明度和阴影设置。
  • TeleportAsyncResult: 传送异步结果用于承载一次传送请求完成后可读取的预留服务器战场实例访问码，帮助开发者把同一批玩家引导到同一个服务器实例中。它不提供自理构造入口，只能由 TeleportService:TeleportAsync 的返回值产生，其核心内容集中在 ReservedServerAccessCode 属性上。
  • TeleportOptions: TeleportOptions 用于配置玩家跨服务器传送时的行为参数，可指定是否预留新服务器、目标实例标识以及携带的自定义数据。通过设置 ReservedServerAccessCode、ServerInstanceId 和 ShouldReserveServer 等属性，能够精确控制传送目标与方式，并利用 SetTeleportData 传递可序列化的上下文信息。
  • Timer: 计时器对象，用于在指定延迟后或按固定间隔重复执行回调函数。它由 TimerService 创建，提供启动、暂停、恢复、取消等控制能力，并可查询运行状态、间隔和剩余次数。
  • Transform: Transform 表示由位移、旋转与缩放组合而成的三维变换，可通过 Translation（或 Position）、Rotation、Scale 属性读写各分量，并借助 LookVector、UpVector、RightVector 获取变换后的坐标轴方向。它提供 Apply、ApplyDirection、PointToWorldSpace、VectorToWorldSpace 等函数在局部空间与世界空间之间转换点与方向，也支持 Inverse 与 GetInverse 求逆、Lerp 与 InterpolateTransforms 插值、ToMatrix 输出矩阵表示。构造上还提供 Identity、FromMatrix、FromEulerAngles、FromAxisAngle、LookAt 等辅助入口。
  • TriggerCallbackInfo: TriggerCallbackInfo 是 TriggerUnit 本地触发事件传入的回调数据，公开提供 OtherUnit，用于标识进入或离开触发区域的另一方单位。该类型不可直接构造。
  • TweenInfo: TweenInfo 是补间动画的配置对象，用于定义动画的持续时间、缓动风格、重复次数等参数。它通过 TweenService 创建补间时传入，控制动画的播放行为。
  • UDim: UDim 表示一维 UI 尺寸，由比例分量和像素偏移分量组成。它常用于定义界面元素的宽度或高度，允许同时按父容器比例和固定像素值来灵活布局。
  • UDim2: UDim2 表示二维 UI 的位置或尺寸，由水平方向和垂直方向的比例值与像素偏移组合而成。
  • Vector2: 二维向量数据类型，用 x 与 y 两个分量描述平面上的坐标、尺寸或方向。除原始分量外还提供 Magnitude、Unit 等派生量，并支持点积、叉积、夹角、线性插值、逐分量取整与近似比较等运算，是处理二维几何与界面布局计算的常用基础结构。
  • Vector2int16: Vector2int16 表示由两个 16 位整数构成的二维向量，常用于网格坐标、区块索引或离散位置表示。它提供简洁的 x、y 分量读写，并支持通过 New 方法快速构造实例。
  • Vector3: Vector3 表示三维空间中的向量数值，可用来描述位置、朝向、速度或缩放等三维量。它提供 x、y、z 三个分量，以及 Magnitude、Unit、Pitch、Yaw 等派生属性，并支持点积、叉积、归一化、插值、逐分量取整与夹角计算等运算。
  • Vector3int16: 三维整数向量，使用 16 位整数存储 X、Y、Z 分量。常用于表示网格坐标、区块索引或离散空间位置，确保数值为整数且范围受限于 16 位。
  • Vector4: Vector4 表示由 x、y、z、w 四个浮点分量构成的四维向量，常用来承载成组出现的四个数值，例如界面图片控件四边拉伸区域的边距。它提供 Length 计算长度、Dot 计算点积、GetMinValue 与 GetMaxValue 取出分量极值，并通过 GetUnit、GetAbsoluteVector 返回派生的向量结果。Magnitude 与 Unit 为只读属性，Normalize 则可对当前向量做就地归一化。

枚举 Enum (86) ​

  • 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 枚举定义了可控制显示或隐藏的核心界面控件类型，包括摇杆、跳跃按钮、冲刺按钮、翻滚按钮、举人按钮、战斗按钮、重置按钮、聊天按钮、表情按钮、玩家列表、生命值、背包、聊天框、顶部栏容器、退出菜单、控制栏和表情菜单。通过该枚举，开发者可以精确管理玩家界面上特定控件的可见性。
  • CurrencyType: CurrencyType 用于标识游戏内可流通的货币种类，目前包含画廊货币与金币两个具名成员。它通常作为货币相关接口的参数或配置字段出现，帮助代码在两种货币之间做出区分。
  • DataStoreErrorCode: DataStoreErrorCode 枚举定义 DataStore 与 OrderedDataStore 相关操作可能涉及的数据存储错误状态，例如参数非法、请求限流、存储不存在、版本无效等。
  • DataStoreType: DataStoreType 枚举用于标识数据存储集合类型，包括普通数据存储、有序数据存储和全局数据存储。
  • DefaultCameraPresetType: DefaultCameraPresetType 枚举定义 CameraService.DefaultCameraPreset 可使用的默认相机预设。
  • DevCameraOcclusionMode: DevCameraOcclusionMode 枚举定义了相机在遇到遮挡物时的处理策略。它提供了三种模式：Zoom 表示拉近相机距离以避免遮挡，Invisicam 表示使遮挡物透明化，EggyHybrid 表示混合使用前两种策略。开发者可通过 CameraUnit 的 DevCameraOcclusionMode 属性来切换这些模式。
  • DevTouchMovementMode: DevTouchMovementMode 是移动端触摸移动模式枚举，用于配置玩家在触屏设备上的虚拟摇杆行为。通过 Enums.DevTouchMovementMode 引用其成员，可设置固定摇杆、动态摇杆或跟随用户偏好等模式。
  • DisplayDistanceType: DisplayDistanceType 枚举控制生物头顶名字与血条的显示距离判定方式。它提供三种模式：不显示、按观察者距离显示、按被观察者距离显示，用于灵活适配不同视角下的信息可见性。
  • EUIAdaptMode: EUIAdaptMode 是定义界面节点边缘自适应模式的枚举，用于决定节点在不同屏幕分辨率下的定位方式。它区分了不进行自适应、按固定数值适配以及按比例适配等不同策略，是 EUI 节点布局系统中描述边缘伸缩行为的关键参数。
  • EUIAnchorAdaptMode: 该枚举用于表示界面节点锚点自适应的处理方式，包含不启用百分比适配和启用百分比适配两种取值。在界面布局需要随屏幕尺寸做比例定位时，它决定锚点是否按百分比参与计算，从而影响控件在自适应过程中的位置表现。
  • EUIArrangeMode: 该枚举用于界定文本内容的排列方式，提供单行与自动换行两种可选策略。在与文本排版相关的控件配置中，开发者可通过它决定文本是强制保持一行，还是依据可用宽度自动折行。
  • EUIFillDirection: EUIFillDirection 枚举用于描述 EUI 网格布局的排列走向，只提供水平与垂直两个方向选项。这类方向信息通常出现在 EUIGridLayout 等布局容器的属性配置中，用来决定子节点按行还是按列依次排布。
  • EUIGridStartCorner: 该枚举用于确定网格自动布局时的起始排列位置，涵盖左上、右上、左下、右下四个角落；当使用 EUIGridLayout 进行单元格自动排序时，它会决定首个子项从哪个角落开始排布，并影响整体流向。
  • EUIHorizontalAlignment: 表示界面布局中水平方向的对齐方式，用于决定子节点在父容器中的横向排列位置。枚举提供左、中、右三个可选成员值，是网格、列表等布局组件配置对齐时的常用取值。
  • EUIListviewGravity: EUIListviewGravity 是用于指定列表视图内容对齐方向的枚举类型，在为 EUIListView 的 ListviewGravity 属性选取取值时使用。它既包含水平方向上的左、右与水平居中，也包含垂直方向上的上、下与垂直居中，可适应不同列表排版需求。
  • EUIOverflowPolicy: 该枚举定义了文本内容超出可用显示区域时的溢出处理方式，包括直接裁剪超出的部分、以省略号截断内容以及自动滚动显示完整文本三种策略，用于控制界面文本在空间有限时的呈现效果。
  • EUIOverflowStrategy: EUIOverflowStrategy 是用于配置文本内容超出显示区域时处理方式的枚举，每种成员对应一种溢出策略，例如自动换行、省略号截断、自动滚动或横向滚动。该枚举通常出现在文本类节点的属性配置中，决定超长文本的最终呈现形式。
  • EUIProgressDirection: 进度方向枚举，用于描述进度条、环形计时等进度类界面元素的自增或填充走向。它提供语义化的方向选项，让进度控件的起始端与前进方向由枚举值表达，从而与具体数字解耦。
  • EUIResetSizePolicy: 用于表达简单富文本标签在文本尺寸变化后如何重置自身尺寸与布局的处理策略，是简单富文本标签组件调整尺寸行为时使用的枚举。AutoScroll 等取值对应自动滚动、按宽度适配和按高度适配等不同的回退方式，供开发者按内容形态选择。
  • EUIScrollDirection: EUIScrollDirection 是用于描述滚动方向的枚举，包含纵向与横向两种取值。通常用来指定滚动列表的滚动轴向，让列表内容按纵向或横向进行滑动呈现。
  • EUISortOrderType: 该枚举用于表达界面布局对子元素的排序依据，提供按布局顺序值和按名称两种规则，决定同一容器内各个子项的先后排列顺序。它通常作为布局容器的排序配置选项，供开发者根据界面层级需要选择合适的排列基准。
  • EUITableMajorAxis: EUITableMajorAxis 是描述表格主轴方向的枚举，提供行优先与列优先两种取值，用于决定一系列界面节点在表格容器中的填充顺序。开发者通过将对应枚举值配置到表格布局的主轴属性，即可快速切换横向或纵向的网格排布效果。
  • EUITextHorizontalAlignment: 该枚举用于描述界面文本在水平方向上的对齐方式，包含左对齐、居中对齐与右对齐三种取值。它作为文本显示节点水平对齐属性的值，决定文字在界面区域内的横向排列效果。
  • EUITextVerticalAlignment: 用于指定文本类界面节点内容的垂直对齐方式，决定文字在组件高度范围内的排布位置。在构建界面布局时可作为文本标签、输入框等组件的对齐配置，配合水平对齐共同控制文字显示位置。
  • EUIVerticalAlignment: 该枚举用于指定界面元素在垂直方向上的对齐方式，提供了顶部、居中和底部三种对齐基准，供各类界面节点在布局时选用。
  • 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 枚举用于标识键盘按键与鼠标按键，取值覆盖字母键、数字键、方向键、功能键、修饰键以及鼠标按键等。它将物理按键抽象为可比较的枚举成员，方便在输入事件回调与按键状态查询中判断用户操作的是哪一个键。
  • 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 表示按排序键降序返回。
  • SpaceCloseReason: SpaceCloseReason 表示 Space 关闭原因，包括未知、官方维护、开发者关闭或更新、服务器为空及内存不足。
  • SurfaceGuiSizingMode: SurfaceGuiSizingMode 是用于描述 SurfaceGui 画布尺寸确定方式的枚举，成员包括 FixedSize 与 PixelsPerWorldUnit，分别对应固定的画布尺寸与按世界单位换算像素的尺寸策略。它通常与 SurfaceGui 的 SizingMode 属性配合使用，并影响 CanvasSize、PixelsPerWorldUnit 与 WorldScale 这几个尺寸相关属性的生效方式。
  • TableMajorAxis: TableMajorAxis 是表示表格主轴排列顺序的枚举，公开值包括 RowMajor 与 ColumnMajor。
  • 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 等，帮助开发者根据玩家注册时长进行差异化处理。