BE教程

[原创]SAPI 基础教程 —— 总目录 & 第一期 初识事件

星空***Lv.4 高级会员 发表于 2025-3-15 IP:山东省 3,295 0
AI 速览2026-09-14 07:50 生成

面向基岩版附加包开发者的 Script API 入门教程,讲解事件机制与基础配置

这是一篇面向已有附加包开发基础的玩家的 Script API 教程,先说明在物品方块事件被移除后 SAPI 成为替代方案,再讲解 JavaScript 与 TypeScript 的学习前提。正文从行为包清单配置入手,介绍如何引入 server 库并创建脚本文件,随后分别梳理 before 类事件与 after 类事件的可用事件、事件数据字段和代码写法,并给出玩家破坏方块、使用雪球、统计死亡次数等示例。适合想用脚本为基岩版附加包补充功能的开发者参考。

  • 需要具备 JavaScript 基础,官方文档示例使用 TypeScript
  • 需对附加包开发有基本认识
  • 使用末尾带 -beta 或 -alpha 的库版本时,创建存档需开启测试版 API 实验性
  • before 类事件中修改游戏状态的 API 无法运行,执行方法需包在 system.run 中
  • 教程内容以官方文档为最新参考源,部分描述作者标注可能不准确
本卡片由 AI 阅读本帖后生成,可能存在疏漏,请以帖子正文为准。

前言


第一期 第二期 第三期

1.20.30 及之后,失去了物品方块事件。而在 1.21.20 及之后,需要假日创造者的组件等随假日创造者离去。对基岩版附加包算是一个不小的打击。这时候,Script API 成为了许多人的选择。
Script  API 通过使用 JavaScript 语言 编写自定义事件、自定义组件、菜单/表单等,在游戏里实现丰富的功能,以弥补被删除的功能 或实现更多丰富的功能。
JavaScript 是什么?
JavaScript 是一种编程语言,用于前端,但很多时候也可以用于许多平台的脚本开发,Script API 就是在Minecraft 基岩版中附加包使用 JavaScript ,来达到丰富的效果。
学习 JavaScript:本教程需要 JavaScript 基础,有条件可以学习 TypeScript,因为官方文档中代码实例是用 TypeScript 语言的。关于 JavaScript 教程、TypeScript 教程以及两者关系,请详见:

在这篇教程中,无法完全展现Script API全部甚至一Server 库的全部,只会将 Server库重要部分,因此需要多次查阅官方附加包文档。

正式查看提醒
本教程要对附加包开发有基本认识,如果没有,可以查看这篇教程:面向附加包开发新人的一些建议
下面教程中,将把 Script API 简称为 SAPI。
本教程需要大家建议,欢迎在本主题下方提建议!
  • Saka*** 铁粒 +50 很棒,支持
您需要登录后才可以回帖 登录 | 立即注册
本版积分规则