工坊手册

主题

单位 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 是同时具备渲染显示与物理模拟能力的三维空间单元，可以配置模型资源、物理资源、碰撞开关、质量、重力、阻尼以及线速度与角速度等参数。它对外提供施加力、冲量与力矩的能力，并能通过碰撞组和互不碰撞配对来管理单元之间的碰撞关系。碰撞进入、碰撞退出以及被其他单元抓举等行为都会以事件形式向外通知。

返回类型索引