教程星火编辑器与口袋方舟编辑器常用API对比
阅读本文大概需要 30 分钟。
本文将从星火编辑器常用 API 和口袋方舟编辑器 API 常用对比，帮助创作者快速上手使用口袋方舟编辑器进行开发。
下面是 API 对比表：
| 星火编辑器 API | 口袋方舟 API |
|---|---|
| 基础控件属性 | UI 控件的基础属性 |
| UI 组件 | API: UIScript 描述：继承自 UIScript 与继承自 Script 的脚本有所不同，继承自 Script 的脚本挂载在对象管理器中，编辑器会自动帮你调用 生命周期函数 |
| API: button 描述：按钮 | API: Button 描述：按钮 API: MaskButton 描述：遮罩按钮 |
| API: label 描述：显示文本或图片的标签 | API: TextBlock 描述：显示文字的控件 API: Image 描述：静态的高保真效果图 |
| API: panel 描述：面板 | API: Canvas 描述：容器是承载其他 UI 控件的背景板，UI 控件也必须依托于容器才能显示和产生作用 |
| API: progress 描述：进度条 | API: ProgressBar 描述：展示百分比的进度效果 |
| API: sprites 描述：序列帧动画 | API: FlipBook 描述：将 UI 贴图按行列切分并按顺序播放实现的 UI 动画效果 |
| API: add_child 描述：添加子控件 | API: addChild 描述：添加子节点 |
| API: remove 描述：移除一个控件以及它的所有子控件 | API: destroyObject 描述：立刻移除并销毁 不可以在使用 |
| API: virtual_joystick 描述：自定义虚拟摇杆 | API: VirtualJoystickPanel 描述：虚拟摇杆 |
| API: event 描述：注册事件 | API: Event.addLocalListener 描述：注册事件（这只是其中之一的本地事件，更加具体的事件系统点这里） |
| API: event_notify，event_dispatch 描述：触发事件 | API: Event.dispatchToLocal 描述：触发事件（这只是其中之一的本地事件，更加具体的事件系统点这里） |
| API:get_or_create_state_machine 描述：客户端单位上的状态机 | API: Animation.slot 描述：由角色的哪些部位进行播放动画。目前可播放动画的部位包括：全身、上半身、下半身。实际应用：我们可以通过该动画部位，控制角色或NPC只播放上半身或下半身的动画，达到动画融合的效果。举个例子，上半身可以播放打招呼的动画，下半身可以播放坐着的姿态，实现上下半身播放不同的动画需求。 |
| API: get_xy 描述：获取坐标 | API: position 描述：获取坐标 |
| API: set_highlight 描述：获取是否高亮 | API: setOutline 描述：添加描边效果 |
| API: is_visible 描述：单位是否可见 | API: opacity 描述：角色不透明度 |
| API: change_model 描述：改变单位的模型 | API: Player.localPlayer.character.description.base.wholeBody 描述：基础人形，多足形象换装 API: Player.localPlayer.character.description.advance.base 描述：高级人形形象形象换装 |
| API: set_xray_enable 描述：设置遮挡显示是否可用 | 可在角色面板上开启"被遮挡时开启描边"，角色被物体遮挡时，会显示角色描边，标记角色位置 |
| API: player 描述：玩家 | API: Player 描述：角色管理器 |
| API: local_player 描述：本地玩家 | API: Player.localPlayer 描述：客户端正在运行的玩家 |
| API: controller 描述：获取玩家控制者 | API: Player.localPlayer.onPawnChange 描述：动态切换玩家当前控制的角色 |
| API: get_hero 描述：获取英雄 | API: Player.localPlayer.character 描述：玩家控制的角色，属于Pawn对象的一种。在玩家切换控制角色时, 客户端上无法立即获取到最新值。其余情况下，只要获取到玩家就可以同时获取到加载完成的控制角色 |
| API: get_hero_name 描述：获取英雄名字 | API: Player.localPlayer.character.displayName 描述：获取头顶名称 |
| API: user_name 描述：用户昵称 | API: Player.localPlayer.character.nickname 描述：玩家昵称 |
| API: set_game_scene 描述：切换客户端场景 | API: TeleportService.asyncTeleportToScene 描述：场景跳转 |
| API: chat 描述：发送聊天 | API: ChatService 描述：聊天服务 |
| API: use_light_group 描述：切换灯光组 | API: Lighting 描述：光照系统 API: PointLight 描述：点光源能实现从一个点向四周发散的光照效果 |
| API: base.game:event('事件名', function (trigger, ...) 描述：创建触发器 | API: Trigger.onEnter 描述：进入触发器事件 API: Trigger.onLeave 描述：离开触发器事件 |
| API: trigger.is_enable 描述：是否启用触发器 | API: Trigger.enabled 描述：触发器是否启用 |
| API: money 描述：货币 | API: PurchaseService.getArkBalance 描述：获取代币余额 |
| API: pay 描述：支付购买 | API: PurchaseService 描述：购买代币商品 |
| API: open_and_set_posteffect 描述：屏幕后效 | API: PostProcess 描述：正常渲染管线结束后，对最终渲染图像进行的后期加工，比如滤镜、模糊等效果。以此来模拟物理摄像机和电影特效 |
| API: set_camera 描述：设置摄像机的位置,旋转 | API: Camera.currentCamera.worldTransform.position，Camera.currentCamera.worldTransform.rotation 描述：设置摄像机跟随 |
| API: camera_focus 描述：相机跟随单位 | API: Camera.currentCamera.lock 描述：摄像机锁定一个物体并跟随 |
| API: lock_camera 描述：锁定相机 | API: Camera.currentCamera.positionMode = CameraPositionMode.PositionFixed 描述：固定摄像机，即切换摄像机的位置模式属性，从而让摄像机固定在一个位置，不再跟随目标移动 |
| 拉起视频激励广告播放页面，并在得到播放结果时处理 | 广告接入指南 |
| API: Vector 描述：向量 | API: Vector 描述：三维向量，由分量 (x,y,z) 组成的三维空间中的向量 API: Vector2 描述：二维向量，由分量 (x,y) 组成的二维空间中的向量 API: Vector4 描述：由分量 (x,y,z,w) 组成的 4D 齐次向量 |
| API: set_scale_xyz 描述：设置缩放值 | API: Scale 描述：变换属性中的旋转决定了游戏对象的缩放 |
| API: set_rotation 描述：设置旋转 | API: Rotation 描述：变换属性中的旋转决定了游戏对象的朝向和角度 |
| API: set_position 描述：设置XYZ坐标 | API: Position 描述：变换属性中的位置确定了游戏对象在游戏世界中的空间坐标 |
| API: play() 描述：播放音效/特效 | API: play() 描述：播放特效，动画，音效 |
| API: stop() 描述：停止播放音效/特效/以及动画 | API: stop() 描述：停止播放特效，动画，音效 |
| API: pause() 描述：停止播放音效 | API: pause() 描述：暂停播放动画，音效 |
| API: resume() 描述：停止播放音效 | API: resume() 描述：恢复播放动画 |
| API: i18n 描述：本地化 | API: LanguageUtil 描述：多语言工具，游戏本地化 |
| API: math 描述：数学 | API: MathUtil 描述：数学库工具 |
| API: QueryUtil 描述：射线检测工具 | |
| API: Timer 描述：计时器 API: DateTime 描述：日期时间 | API: TimeUtil 描述：时间工具 |
| API: Tween 描述：补间(动画)，允许你以平滑的方式更改对象的属性 | |
| API: ScreenPos 描述：屏幕坐标 API: screen 描述：屏幕 | API: ScreenUtil 描述：屏幕视口工具 |
| API: InputUtil 描述：输入事件工具，映射键盘按键 API: KeyEvent 描述：按键事件 | |
| API: AISearcher 描述：AI搜索器 | API: Navigation 描述：寻路 API: NavLink 描述：寻路链接能将导航网格体内没有直接路径的区域链接起来 |
| API: Region 描述：区域 API: RegionCircle 描述：圆形区域 API: RegionRect 描述：矩形区域 | API: Trigger 描述：触发器区域 |
| API: MaterialSlot 描述：Model插槽，执行材质相关操作 | |
| API: RoomSettings 描述：房间设置 API: TeleportService 描述：多场景和传送服务 API: RoomInfo 描述：玩家所在的房间信息 | |
| API: base 描述：基类 | API: Script 描述：脚本的基类 |
| API: Target 描述：目标 API: Unit 描述：单位 API: UnitGroup 描述：单位组 API: target_filters 描述：单位过滤器 API: SceneObject 描述：场景对象 API: Actor 描述: 表现 | API: GameObject 描述：Model、Pawn、Camera、AdvancedVehicle、BlockingVolume等逻辑对象均继承自GameObject API: GameObjPool 描述：用于缓存GameObject的对象池，适用资源库资源、场景对象、预制体的复用缓存 API: ObjPool 描述：通用对象池，可用于各种类型对象的复用 |
| API: DataCache 描述：数据编辑器表 API: ScoreData 描述：云变量数据 | API: DataStorage 描述：数据存储 API: ModuleS 描述：服务端模块的基类，所有的服务端模块都必须继承这个类，才能被 ModuleService 管理 API: ModuleC 描述：客户端模块的基类，所有的客户端模块都必须继承这个类，才能被 ModuleService 管理 API: ModuleService 描述：服务端客户端及数据模块管理API:Subdata 描述：数据控制类的基类 API: DataCenterS 描述：服务端数据中心，管理所有玩家的数据。 API: DataCenterC 描述：客户端数据中心，里面存放着当前玩家的数据 |