主题
服务 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 则直接暴露当前使用的相机单位。