Custom Item API

插件

· 作者 Senne

一个用于创建自定义方块和自定义物品的 API。

0 本站下载 0 关注 更新于 2 年前

最新 5.5 · 1.21 · Paper

一键开服(送7天)

一个用于在 PaperMC 上为 1.20+ 版本创建自定义方块和物品的 API

如何使用?

数据驱动的方块与物品

创建一个“包”

以这种方式创建自定义物品和方块时,你需要创建一个类似于数据包或资源包的“包”。其文件结构如下所示:

- <命名空间>
   - blocks(方块)
      - default_block(默认方块)
      - transparent_block(透明方块)
   - items(物品)

你的包的命名空间将在 give 命令中显示在物品 ID 之前,格式为 namespace:item_id。

添加物品

要添加一个物品,你只需创建一个 json 并将其放入 items 文件夹中。文件名将成为该物品的 ID。

添加方块

要添加一个方块,你需要创建一个 json。如果你希望它是一个透明方块,需要将其放入 transparent_block 文件夹中。建议将放置后的方块也设为透明,否则外观可能会很奇怪。如果你想要一个普通方块,请将 json 文件放入 default_block 文件夹中。文件名将成为方块的 ID,为了良好的实践,建议使这个 ID 与其对应物品的 ID 相同,但这并非必需。

使用“包”(Pack)

要使用一个“包”,你需要将其放入 packs 文件夹中。该文件夹位于 plugins 文件夹下的 custom_item_api 文件夹内。

- plugins
   - Custom_Item_Api
	- packs

通过插件添加方块和物品

自定义物品

你可以通过创建 new CustomItem(Material material, NamespacedKey key, Class actions) 来添加一个自定义物品。
如果不存在具有该 NamespacedKey 的自定义物品,这将创建一个新的自定义物品。actions 定义了点击该物品时应发生的行为,它是一个实现了 CustomItemActions 接口的类。
你可以更改纹理、标签等。
如果你想使用此物品放置自定义方块,可以通过 CustomItem#setCustomBlock(NamespacedKey) 添加相关设置。

示例:

NamespacedKey itemKey = new NamespacedKey(plugin, "example_item");
CustomItem customItem = new CustomItem(Material.FURNACE, itemKey, Class.forName("org.super_man2006.custom_item_api.utils.items.EmptyCustomItemAction"));
customItem.setCustomBlock(blockKey);
customItem.setName(Component.text("Example"));

自定义方块

你可以通过创建 new CustomBlock(Material material, NamespacedKey key, Class actions, Material placedBlock) 来添加一个自定义方块。
如果不存在具有该 NamespacedKey 的自定义方块,这将创建一个新的自定义方块。actions 定义了放置/破坏/右键点击该方块时应发生的行为,它是一个实现了 CustomBlockActions 接口的类。
你可以更改纹理、标签等。
该方块使用的是物品纹理,而非方块纹理。这意味着如果你设置了自定义模型数据(cmd),可以更改其纹理。
如果你想在此方块被破坏后掉落一个自定义物品,可以通过 CustomBlock#setDropItem(NamespacedKey) 进行设置。

示例:

NamespacedKey blockKey = new NamespacedKey(plugin, "example_block");
CustomBlock customBlock = new CustomBlock(Material.FURNACE, blockKey, Class.forName("org.super_man2006.custom_item_api.utils.blocks.EmptyCustomBlockAction"), Material.STONE);
customBlock.setRotation(CustomBlock.Rotation.AROUND_Y);

功能 / 错误报告

如果你发现了错误或希望添加新功能,请在 Discord 中提问,或在 GitHub 上创建一个 Issue。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源