Cobblemon KubeJS

Cobblemon KubeJS

Cobblemon KubeJS 将 Cobblemon 数据和事件暴露给 KubeJS 脚本。

游戏机制

Cobblemon KubeJS Bridge

将 Cobblemon 的数据、事件、存储查询、管理工具以及客户端图鉴显示带入 KubeJS。

Cobblemon KubeJS Bridge 让整合包开发者能够使用 JavaScript 构建自定义进度、任务、奖励、命令、界面、战斗系统和服务器机制。

特性

Cobblemon 事件

监听服务端事件,例如:

  • 图鉴进度变化
  • 宝可梦扫描与捕获
  • 宝可梦放出、收回、濒死、获得、治疗或释放
  • 经验获取与升级
  • 进化完成
  • 战斗胜利与失败
  • 战斗逃跑与认输
CobblemonEvents.pokemonCaptured(event => {
  event.player.tell(
    `You caught ${event.species} at level ${event.level}!`
  )
})

图鉴 API

查询玩家的图鉴进度:

  • 检查某个物种是否被看见或捕获
  • 统计已看见或已捕获的物种总数
  • 按元素类型统计进度
  • 读取单个物种的进度
var caughtFire = CobblemonJS.pokedex.countCaughtByType(
  player,
  'fire'
)

物种 API

  • 校验物种 ID
  • 列出已实现的物种
  • 读取物种类型
  • 校验元素类型
  • 查找某一类型的所有物种

同时支持短 ID 和带命名空间的 ID:

CobblemonJS.species.exists('charizard')
CobblemonJS.species.exists('cobblemon:charizard')

队伍与 PC API

从玩家的队伍和 PC 中读取安全的宝可梦快照:

  • 按 UUID 搜索宝可梦
  • 按物种或类型统计宝可梦数量
  • 保留队伍、PC、盒子和槽位信息
  • 读取等级、HP、性格、特性、招式、个体值、努力值、状态、携带物品等
var party = CobblemonJS.pokemon.getParty(player)
var pokemon = CobblemonJS.pokemon.getByUuid(player, pokemonUuid)

管理工具

受信任的服务器脚本可以:

  • 给予玩家一只宝可梦
  • 治疗玩家的队伍
  • 在玩家附近生成一只宝可梦
  • 在指定坐标生成一只宝可梦且不分配所有者
CobblemonJS.admin.givePokemon(
  player,
  'charizard level=50 shiny=true'
)

CobblemonJS.admin.spawnPokemon(
  player.serverLevel,
  'rayquaza level=70',
  100,
  80,
  -50
)

客户端图鉴同步

服务器会将只读的图鉴缓存同步到所属客户端。客户端脚本可以使用它实现实时提示框和其他界面,而无需每帧向服务器请求数据。

CobblemonClientJS.pokedex.countSeen()
CobblemonClientJS.pokedex.countCaught()
CobblemonClientJS.pokedex.countCaughtByType('fire')

随附的示例包含一个经过测试的动态望远镜提示框。

要求

  • Cobblemon
  • KubeJS
  • Rhino(KubeJS 所需)
  • Java 21

使用同步客户端图鉴 API 时,需要在客户端和服务端都安装该桥接模组。

加载器支持

目前支持 NeoForge。

暂不支持 Fabric。Fabric 模块仅为编译期存根,不提供事件、API 或客户端同步。

文档与示例

本项目包含:

  • 完整的 API 文档
  • 每个函数的参数与返回值
  • 完整的事件字段参考
  • 宝可梦与招式数据模型参考
  • 服务端与客户端脚本示例
  • 故障排除说明

链接

注意事项

  • 返回给脚本的宝可梦快照是只读的。
  • 管理方法会修改游戏状态,只应通过受信任的脚本并配合适当的权限检查来暴露。
  • 图鉴计数代表已实现的唯一物种,而非重复捕获。
  • 未知物种、类型、格式错误的 UUID 以及无效的生成属性会产生描述性的脚本错误。
  • 替换模组 jar 或网络代码需要完全重启。