Skip to content

服务 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 世界的宿主服务,负责容纳所有存在于场景中的单位对象,例如 WorldUnitModelUnitEffectUnit 等。当这些单位作为 World 的后代时,它们处于活跃状态:具有物理属性的单位会被渲染、参与物理模拟并与其他单位及世界交互;脱离 World 层级的对象不会被渲染,也不会参与物理计算,直到重新挂载到 World 树中。World 还承担创建单位、加载资源、提供服务器时间以及响应自定义事件等职责。

返回类型索引