开发者 API 概述

Estimated reading time: 2 minutes

ModLoader 通过全局对象向 Mod 开发者暴露一组公共 API,用于查询 Mod 信息、实现 Mod 间通信、加载图片等。

全局对象

全局对象说明
window.modUtils面向 Mod 开发者的主要 API 入口
window.modSC2DataManager核心数据管理器,提供底层功能访问
window.jsPreloader脚本预加载器
window.modAddonPluginManagerAddon 插件管理器

API 分类

SugarCube2 事件

SC2 引擎在运行过程中会触发以下 jQuery 事件,Mod 可以监听这些事件来响应游戏状态变化:

事件名触发时机
:storyready游戏完全启动完毕
:passageinit新 Passage 上下文开始初始化
:passagestart新 Passage 开始渲染
:passagerender新 Passage 渲染结束
:passagedisplay新 Passage 准备插入到 HTML
:passageend新 Passage 处理结束

监听示例

// 只触发一次
$(document).one(":storyready", () => {
  // 游戏启动后的初始化逻辑
});

// 每次触发
$(document).on(":passageend", () => {
  // 每个 Passage 渲染完毕后的处理
});