Repository navigation
KubeJS API
本页为参考文档. 入门流程见 KubeJS 集成.
event.create(id, type) 的第二个参数仅接受以下五个值:
| 类型 | builder | 源码文件 |
|---|---|---|
steam_letters:boiler |
BoilerBuilder |
BoilerBuilder.java |
steam_letters:solar |
SolarBoilerBuilder |
SolarBoilerBuilder.java |
steam_letters:solid_burner |
SolidBurnerBuilder |
SolidBurnerBuilder.java |
steam_letters:fluid_burner |
FluidBurnerBuilder |
FluidBurnerBuilder.java |
steam_letters:engine_and_flywheel |
SteamEngineDeviceBuilder |
SteamEngineDeviceBuilder.java |
各列源码位于 compat/kubejs/builder.
五个 builder 均继承 DeviceBuilder, 因此通用方法在各类型上基本一致.
| 方法 | 说明 |
|---|---|
material(ResourceLocation) |
决定模型与贴图目录. 默认 steam_letters:bronze
|
model(ResourceLocation) |
完整模型路径. 未指定时由设备目录与材质推导 |
capacity(int) |
内部罐容量, 单位 mB. 未指定时使用该设备的默认常量 |
blockTag(tag) |
仅对方块添加标签 |
itemTag(tag) |
仅对方块物品添加标签 |
tagBoth(tag) |
对方块与方块物品同时添加标签 |
基类的 tag(tag) 仅作用于方块. 需要物品同时携带标签时使用 tagBoth.
material("steam_letters:bronze") 为特例: 使用该材质时不生成模型, 直接引用模组自带的青铜模型. 需要使用自定义外观时, 改用其他材质.
指定 model(...) 后, 该类型不再生成方块模型, 即模型由脚本提供. blockstate 与物品模型仍会生成并指向该路径, 因此需将 json 置于 assets/<model 的命名空间>/models/<路径>.json. 注意此处为 model 的命名空间, 而非方块 id 的命名空间.
| 方法 | 单位 | 适用类型 |
|---|---|---|
production(v) |
mB/tick | 锅炉, 太阳能锅炉 |
maxHeat(v) |
热量 | 固体燃烧室, 流体燃烧室 |
strength(v) |
SU | 引擎 (飞轮同时使用) |
speed(v) |
RPM | 引擎 |
consumption(v) |
mB/tick | 引擎 |
引擎自预热第一 tick 起即以 speed(v) 指定的转速运行, 不随进度变化.
关于 0: 各设备对 0 的处理不一致. 引擎的 strength / speed / consumption 为 0 或负数时回退到默认值, 燃烧室的 maxHeat(0) 同样回退默认; 锅炉的 capacity(0) 与 production(0) 则为实际值, 得到容量为 0, 不产出蒸汽的设备. 需要默认值时, 删除对应参数行.
%s 为材质路径, 前缀为材质的命名空间. 目录位于 assets/<材质命名空间>/textures/ 下.
| 族 | 生成的模型 | 所需贴图 |
|---|---|---|
| 锅炉 | 1 个 |
block/steam/boiler/%s/side, /top
|
| 燃烧室 |
<base> 与 <base>_lit
|
block/steam/<solid_burner 或 fluid_burner>/%s/side, /top, /down, /off, /on
|
| 太阳能锅炉 | 1 个, 内置造型 |
block/steam/solar_boiler/%s/side, /top, /down
|
| 引擎 |
<base> 与 <base>_item
|
block/steam/casing/%s_casing, block/steam/engine/%s_cylinder, block/steam/metal_block/%s_block
|
| 飞轮 | 外壳三种变体, 轮盘, 四个连接件, _item
|
block/steam/flywheel/%s_wheel, block/steam/casing/%s_casing, block/steam/gearbox/%s_gearbox
|
两点说明:
- 锅炉底面固定使用模组自带的
steam_letters:block/steam/down, 无需提供 bottom 贴图 - 燃烧室的
off与on为正面贴图的两种状态, 对应方块状态的lit
| 产物 | 规则 |
|---|---|
| blockstate | 锅炉与太阳能为单一 variant; 燃烧室与引擎包含 facing 与 lit; 飞轮包含 facing 与 connection
|
| 物品模型 | 默认 parent 到方块模型; 引擎与飞轮使用独立的 _item 模型 |
| 语言键 |
block.<id 命名空间>.<id 路径>, 文本由路径按下划线拆词并首字母大写 |
需要中文名称时, 在 kubejs/assets/<id 命名空间>/lang/zh_cn.json 中覆盖对应键.
脚本注册的设备均带有以下方块标签: minecraft:mineable/pickaxe, minecraft:needs_stone_tool, create:wrench_pickup.
按类型额外添加的物品标签:
| 类型 | 物品标签 |
|---|---|
boiler |
steam_letters:steam_boiler, steam_letters:steam_production
|
solar |
steam_letters:steam_solar_boiler, steam_letters:steam_production
|
solid_burner |
steam_letters:steam_solid_burner, steam_letters:steam_production
|
fluid_burner |
steam_letters:steam_fluid_burner, steam_letters:steam_production
|
engine_and_flywheel |
引擎 steam_letters:steam_engine, 飞轮 steam_letters:steam_flywheel
|
这些标签与模组自带设备一致, 可用于整合包的批量替换与检索.
两种类型均为 Create 的 processing recipe 格式, 键只有 fuel 与 time:
-
steam_letters:solid_fuel:fuel为物品或物品标签 -
steam_letters:fluid_fuel:fuel为流体或流体标签
脚本中的写法:
ServerEvents.recipes((event) => {
let { steam_letters } = event.getRecipes()
steam_letters.solid_fuel("minecraft:coal", 200)
steam_letters.solid_fuel("#minecraft:coals", 100) // 标签
steam_letters.fluid_fuel("#forge:lava", 600) // 标签
})对应的 json 结构:
{
"type": "steam_letters:solid_fuel",
"ingredients": [
{
"item": "minecraft:coal"
}
],
"results": [],
"time": 200
}物品标签将 item 替换为 tag, 值不带 #; 流体为 { "fluid": "minecraft:lava", "amount": 1000 }, 流体标签替换为 fluidTag. amount 在代码内固定为 1000, 无需指定.
流体亦可通过 FuelFluid.ofFluid(Fluid.of("minecraft:lava")) 或 FuelFluid.ofTag("forge:lava") 显式构造.
| 名称 | 说明 | 示例 |
|---|---|---|
SlApis |
资源 id 工具 |
SlApis.loadResource("bronze") 返回 steam_letters:bronze
|
CreateLettersSteam |
模组主类 | CreateLettersSteam.MODID |
FuelFluid |
流体燃料包装 | FuelFluid.ofTag("forge:lava") |
SlApis 另提供 loadResource() 与 getFuelAmount().
以下为游戏内导出的类定义, 包含继承自基类的方法, 供补全参考. 其余四个 builder 的方法与之基本一致, 差别仅在于上文"类型专属方法"中不适用于该类型的部分.
BoilerBuilder
class BoilerBuilder extends Internal.BoilerDeviceBuilder<Internal.SteamBoilerBlock, Internal.SteamBoilerBlockEntity, Internal.BoilerBuilder> {
constructor(id: ResourceLocation_)
getClass(): typeof any;
/**
* Tags the block item only (data/<ns>/tags/items)
*/
itemTag(tag: ResourceLocation_): this;
createAdditionalObjects(): void;
/**
* Full model path. When omitted it is derived from the device directory and the material
*/
model(model: ResourceLocation_): this;
/**
* Base steam output per tick at 100% efficiency (mB/tick)
*/
production(production: number): this;
/**
* Sets the translation key for this object, e.g. `block.minecraft.stone`.
*/
translationKey(key: string): dev.latvian.mods.kubejs.registry.BuilderBase<Internal.Block>;
createObject(): any;
getTranslationKeyGroup(): string;
/**
* Tags the block only (data/<ns>/tags/blocks)
*/
blockTag(tag: ResourceLocation_): this;
notify(): void;
get(): Internal.Block;
wait(arg0: number, arg1: number): void;
/**
* Material. Determines the default model and texture directory. Defaults to steam_letters:bronze
*/
material(material: ResourceLocation_): this;
generateDataJsons(generator: Internal.DataJsonGenerator_): void;
/**
* Internal tank capacity in mB. When omitted the device default is used
*/
capacity(capacity: number): this;
getRegistryType(): RegistryInfo<any>;
/**
* Tags both the block and the block item
*/
tagBoth(tag: ResourceLocation_): this;
/**
* Makes displayName() override language files.
*/
formattedDisplayName(): dev.latvian.mods.kubejs.registry.BuilderBase<Internal.Block>;
/**
* Adds a tag to this object, e.g. `minecraft:stone`.
*/
tag(tag: ResourceLocation_): dev.latvian.mods.kubejs.registry.BuilderBase<Internal.Block>;
toString(): string;
notifyAll(): void;
transformObject(obj: Internal.Block_): Internal.Block;
getBuilderTranslationKey(): string;
hashCode(): number;
wait(): void;
/**
* Combined method of formattedDisplayName().displayName(name).
*/
formattedDisplayName(name: net.minecraft.network.chat.Component_): dev.latvian.mods.kubejs.registry.BuilderBase<Internal.Block>;
wait(arg0: number): void;
/**
* Sets the display name for this object, e.g. `Stone`.
*
* This will be overridden by a lang file if it exists.
*/
displayName(name: net.minecraft.network.chat.Component_): dev.latvian.mods.kubejs.registry.BuilderBase<Internal.Block>;
generateLang(event: Internal.LangEventJS_): void;
equals(arg0: any): boolean;
newID(pre: string, post: string): ResourceLocation;
generateAssetJsons(generator: Internal.AssetJsonGenerator_): void;
get class(): typeof any
get translationKeyGroup(): string
get registryType(): RegistryInfo<any>
get builderTranslationKey(): string
}