星火开发者快速入门指南 ​

随着游戏功能日渐增多、逻辑越来越复杂，创作者们更习惯于使用代码进行游戏开发。口袋方舟编辑器正好满足这一需求，我们不仅提供了官方的代码支持，还配备了众多插件、预制体和功能对象，以帮助开发者更快捷地实现游戏逻辑。

在联机方面官方也提供了免费的服务器供大家使用，真正实现一套代码发布到不同平台（PC、Android、IOS）。

游戏发布后我们还提供了完整的运营工具，帮助创作者分析游戏数据、排查线上错误等。

1. 安装与环境配置 ​

1.1 安装编辑器 ​

详细教程请阅读这篇：安装与启动 | 教程

访问口袋方舟官网，在页面中间点击 “下载编辑器” 按钮，来下载我们的启动器，根据教程安装好之后我们来对比进行学习。

1.2 项目管理 ​

详细介绍可以查阅这篇教程：安装与启动| Editor使用 | 教程

在口袋方舟中，创建项目同样可以使用编辑器自带模板或空工程模板。在口袋方舟中提供了两类模板，首页图中间有文字的是带有完整游戏逻辑的项目，除了这些带有逻辑的项目外是美术提供的主要用于展示美术效果的模板。

❗ 在口袋方舟中游戏开发中生产的资源、代码合并称之为游戏工程，与星火中的项目概念是等价的。

口袋方舟中的创建新工程	星火中创建新项目

历史工程管理同样也在编辑器页签中，不同的是我们需要选中下方工程按钮

口袋方舟中的历史工程	星火中的历史项目

1.2 代码编辑器安装 ​

Visual Studio Code 安装详细教程可以看这篇： VSCode 安装 | 教程

在口袋方舟中我们同样使用的是 Visual Studio Code 进行代码开发，下文为了方便我简写为 VSCode。

• 编辑器无需特定 VSCode 版本，大家直接去官网下载最新版本即可。
• 无需安装任何插件，使用 VSCode 自带的功能即可实现断点调试功能。

1.3 配置断点调试 ​

依托于 VSCode 自身功能，我们只需要配置一下 launch.json 文件即可实现断点调试功能。

① 点击运行与调试按钮

② 点击创建 launch.js 文件 (如果之前有过配置可以新增一个)

③ 选择 Node.js

这样就可以创建一个调试配置文件，接下来需要替换为我们官方提供的配置文件，即可进行调试。

配置文件下载：https://arkimg.ark.online/launch.json

2. 编辑器基础操作 ​

下面仅列出最常见功能，详细教程可以看这篇：编辑器界面 | 教程

2.1 场景物体管理 ​

在口袋方舟中，场景内的所有物体会显示在对象管理器中，类似于星火中的场景列表。

口袋方舟中的场景管理器	星火中场景物体管理器

2.2 场景物体属性面板 ​

在口袋方舟中选中场景上的物体，同样会将该对象身上的属性列出到属性面板中

口袋方舟中的属性面板	星火中的属性面板

2.3 编辑器资源库 ​

在口袋方舟中，官方提供了海量不同风格的免费资源帮助创作者进行游戏开发，在左侧资源库中可以根据不同分类选择合适的资源，拖入场景中。

在口袋方舟中资源大体分为两类：

• 美术资源：比如模型、材质、服装、音频等，这些用来构筑游戏的效果。
• 功能对象：内置了功能逻辑，仅需使用胶水代码将他们粘合起来即可实现多种游戏逻辑

美术资源	功能对象

2.4 运行游戏 ​

在口袋方舟中运行游戏十分简单，可以点击最上方页签中的运行按钮，因为我们原生支持联机所以需要设置下当前要启动几个客户端进行游戏。

0.41 之后版本的运行按钮	0.40 版本的调运行按钮

2.5 外部资源导入 ​

在口袋方舟中，工程内用到的资源全部放置在工程内容页签下。如果需要导入任何外部资源都可以点击资源导入按钮进行导入。

详细导入教程可以看这篇：资源导入上传工具 | 产品手册

2.2 界面编辑器 ​

UI 相关详细教程：创建游戏界面 (UI) | 产品手册

在口袋方舟中我们称界面为 UI，制作 UI 需要打开 UI 编辑器进行创作，接下来我们来使用 UI 编辑器打开默认的操作 UI：

在工程内容中双击 DefaultUI ，它是我们每个项目自带的控制 UI，包含了摇杆和跳跃按钮等控件。双击打开之后就会进入到我们的 UI 编辑器：

在口袋房中每个 UI 文件代表着一整个界面，可以在 UI 编辑器的对象管理器中查看当前 UI 文件中已有的控件

口袋方舟中 UI 文件中已有控件列表	星火中界面上已有控件列表

在口袋方舟中提供了相当多的控件供创作者们快速制作各类界面：

口袋方舟中的 UI 控件	星火中的 UI 控件

3.代码开发概述 ​

3.1 创建脚本 ​

详细教程可以查看：脚本 | 教程

在口袋方舟中脚本主要分为两种：

• 普通脚本：普通脚本可以运行在服务端、客户端，可以将它们添加到场景上的物体上。这类脚本主要用于实现游戏中各类逻辑。
• UI 脚本：UI 脚本只能添加到 UI 文件上，并且只能运行在客户端（因为服务端没有 UI ），这类脚本用于实现 UI 效果、响应按钮等控件的点击事件等。

在工程内容里可以根据需求创建对应的脚本。

3.2 脚本编写差异 ​

详细教程可以查阅：脚本 生命周期| 教程

在星火中所有的代码都是由触发器接收到某个事件之后开始执行，而在口袋方舟中更符合传统游戏引擎的实现，是每个脚本可以附加在一个游戏对象上，在游戏运行后开始执行各自的生命周期。

口袋方舟中脚本的常见生命周期：

• onStart ：运行时执行一次。
• onUpdate：setUpdate 设置为 true 后，每帧被执行，设置为false，不会执行。
• onDestroy ：被销毁时调用。

一个空白的脚本是这样的：

@Component
export default class GameStart extends Script {

    /** 当脚本被实例后，会在第一帧更新前调用此函数 */
    protected onStart(): void {
    }

    /**
     * 周期函数 每帧执行
     * 此函数执行需要将this.useUpdate赋值为true
     * @param dt 当前帧与上一帧的延迟 / 秒
     */
    protected onUpdate(dt: number): void {
    }

    /** 脚本被销毁时最后一帧执行完调用此函数 */
    protected onDestroy(): void {
    }
}

@Component
export default class GameStart extends Script {

    /** 当脚本被实例后，会在第一帧更新前调用此函数 */
    protected onStart(): void {
    }

    /**
     * 周期函数 每帧执行
     * 此函数执行需要将this.useUpdate赋值为true
     * @param dt 当前帧与上一帧的延迟 / 秒
     */
    protected onUpdate(dt: number): void {
    }

    /** 脚本被销毁时最后一帧执行完调用此函数 */
    protected onDestroy(): void {
    }
}

3.3 服务端与客户端 ​

在星火中，触发器分为服务端触发器、客户端触发器，在口袋方舟中同样有类似的概念，只不过我们还多了一个：双端。

• 服务端：只运行在服务端。
• 客户端：只运行在客户端中，比如 UI 脚本。
• 双端：由服务器创建，自动同步到客户端的脚本。

在编辑器中，双端脚本可以使用 SystemUtil.isClient() 和 SystemUtil.isServer() 函数来区分该段代码的运行环境，在口袋方舟中，脚本可以附加在游戏对象上，所以脚本的运行环境与取决于游戏对象的运行环境。可以在对象面板上修改它：

如上图：S 代表这是一个纯服务端对象，C 代表这是一个纯 C 端对象，S&C 就代表着它是一个双端对象了~

3.4 查找游戏对象 ​

详细教程可以查看 ：

游戏对象 | 教程

修改游戏对象 | 教程

在口袋方舟中，场景上所有的物体都称之为游戏功能对象（GameObject），在脚本中它们也都继承自统一的基类GameObject

要在获取场景上的一个物体，可以使用 GameObject.asyncFindGameObjectById("") 方法进行异步查找游戏对象，找到之后可以使用 as 关键字转换为对应类型。

eg：查找场景上一个触发器，并添加进入事件：

protected onStart(): void {
    if (SystemUtil.isClient()) {
        GameObject.asyncFindGameObjectById("357C1504").then(go=>{
            const trigger = go as Trigger;
            trigger.onEnterTrigger.add((this.TriggerEnter.bind(this));
        });
    }
}

protected onStart(): void {
    if (SystemUtil.isClient()) {
        GameObject.asyncFindGameObjectById("357C1504").then(go=>{
            const trigger = go as Trigger;
            trigger.onEnterTrigger.add((this.TriggerEnter.bind(this));
        });
    }
}

另外场景上还有一些世界对象，这些游戏对象在每个游戏场景中都是唯一的，所以口袋方舟封装了一些单例来操作它们：

• 摄像机：Camera
• 后处理：PostProcess
• 雾效果：Fog
• 环境光：Lighting

更多 API 可以查阅我们的 API 手册：口袋方舟 | API

3.5 创建游戏对象 ​

上一小节讲到了搜索场景中已存在的游戏对象，接下来我们来学习下如何使用代码创建指定的游戏对象。在口袋方舟中所有的游戏对象都是通过Spawn接口进行创建的，由于资源加载需要一定的时间建议创作者们全部使用异步方法进行生成也就是GameObject.asyncSpawn

eg: 生成一个模型

@Component
export default class GameStart extends Script {

    /** 当脚本被实例后，会在第一帧更新前调用此函数 */
    protected onStart(): void {

        if (SystemUtil.isClient()) {
            GameObject.asyncSpawn("360264").then(go => {
                go.worldTransform.position = Vector.zero;
            });
        }
    }
}

@Component
export default class GameStart extends Script {

    /** 当脚本被实例后，会在第一帧更新前调用此函数 */
    protected onStart(): void {

        if (SystemUtil.isClient()) {
            GameObject.asyncSpawn("360264").then(go => {
                go.worldTransform.position = Vector.zero;
            });
        }
    }
}

3.6 本地玩家与其他玩家 ​

在口袋方舟中，当前客户端控制的玩家称之为本地玩家，与星火中同名的概念类似，在客户端中直接使用 Player.localPlayer; 即可获取。

eg：在游戏开始后在客户端获取本地玩家：

@Component
export default class GameStart extends Script {
    /** 当脚本被实例后，会在第一帧更新前调用此函数 */
    protected onStart(): void {
        if (SystemUtil.isClient()) {
            const localPlayer = Player.localPlayer;
        }
    }
}

@Component
export default class GameStart extends Script {
    /** 当脚本被实例后，会在第一帧更新前调用此函数 */
    protected onStart(): void {
        if (SystemUtil.isClient()) {
            const localPlayer = Player.localPlayer;
        }
    }
}

如果要获取其他玩家，可以使用Player.getAllPlayers()方法获取房间内所有玩家数组，要获取某个指定玩家可以通过该玩家的userId使用Player.getPlayer("xxxxxx")方法来获取。

4. 其它学习资料 ​

4.1 常用网址 ​

API 查询，这里罗列了当前所有可用 API ：口袋方舟 | API

产品手册，这里罗列了每个功能的详细介绍：口袋方舟 | 产品手册

教程文档，包含常用逻辑的实现方法与功能快速上手：口袋方舟 | 教程

创作者论坛，遇到使用问题或者交流创作心得都可以在这里发帖：口袋方舟论坛｜创作者社区

开箱可用，这里有大量官方和第三方分享的功能预制体：开箱可用 - 口袋方舟论坛

4.2 TS 教程 ​

文档教程：TypeScript 学习 | 教程

视频教程：零基础系列课程一：TypeScript