Accessory API

模组

· 作者 Slainlight

为 Babric 工具链中的 b1.7.3 提供配件 API

0 本站下载 0 关注 更新于 5 个月前

最新 0.9.1+mcb1.7.3+babric · Babric

一键开服(送7天)

补充说明:

Aether for Station API 使用了本模组!

Accessory API

在 b1.7.3 中使用 Babric,本模组提供了一个 API,用于添加类似于 Trinkets API 和 Baubles API 的各种物品的额外插槽,其样式灵感源自 b1.7.3 的 Aether。

开发者用法

要了解如何使用 babric 工具链为 b1.7.3 进行模组开发,请加入 The Modification Station!
它与 fabric 和 fabric-api 非常相似,但适用于 b1.7.3。

工作区

将 Accessory API 添加到你的 build.gradle 中

repositories {
    maven {
        name = "Jitpack"
        url "https://jitpack.io/"
    }
}

dependencies {
    modImplementation('com.github.matthewperiut:accessory-api:0.5.1') {
        transitive false
    }
}

建议

如果你想快速了解如何使用此 API,请克隆仓库(最好在 IDE 中)并导航至 src/test/java/com/matthewperiut/testmod。
同时查看 API 的 javadocs / 文档

实现

在你的物品类中实现 "Accessory" (配合 STAPI 使用,也可与任何 API/mixins 配合)

public class ExampleRing extends TemplateItemBase implements Accessory
{
    public Pendant(Identifier identifier)
    {
        super(identifier);
    }
    
    // 定义该物品可以放入的饰品插槽类型:
    @Override
    public String[] getAccessoryTypes(ItemInstance item)
    {
        return new String[]{ "ring" };
        // return new String[0]; // 返回无插槽
        // return new String[]{ "ring", "cape" }; // 可放入多种类型的插槽
        // return new String[]{ "all" }; // 可放入任意饰品插槽
    }

    // 其他可用的方法,请使用 @Override
    // void tickWhileWorn(PlayerBase player, ItemInstance accessory)
    // void onAccessoryAdded(PlayerBase player, ItemInstance accessory)
    // void onAccessoryRemoved(PlayerBase player, ItemInstance accessory)

    // 渲染相关
    private YourCustomRenderer renderer;
    @Override
    public Optional<AccessoryRenderer> getRenderer()
    {
        return Optional.ofNullable(renderer);
    }
}

你可以选择不同的默认饰品类型:
"pendant"(吊坠) "cape"(披风) "shield"(盾牌) "ring"(戒指) "gloves"(手套) "misc"(杂项) "all"(全部)
或者使用你自己的自定义饰品类型

饰品函数详解

当玩家使用物品点击饰品插槽时调用此函数,物品会作为参数传入。
这提供了插槽信息以检查其兼容性。
String[] getAccessoryTypes(ItemInstance item)

此函数在关联玩家的 tick 函数中被调用,传递正在被 tick 的物品及对应的玩家。
void tickWhileWorn(PlayerBase player, ItemInstance item)

当与饰品相关的库存中添加/移除物品时调用此函数。
该函数提供了添加/移除饰品的玩家以及被添加/移除的物品。
void onAccessoryAdded(PlayerBase player, ItemInstance accessory)
void onAccessoryRemoved(PlayerBase player, ItemInstance accessory)

通过 getRenderer 提供渲染函数:
public AccessoryRenderer getRenderer()

创建饰品渲染器

示例:

public class CustomRenderer implements AccessoryRenderer {
    void renderThirdPerson(PlayerBase player, PlayerRenderer renderer, ItemInstance itemInstance, double x, double y, double z, float h, float v)
    {
        // 执行实体渲染逻辑
    }

   void renderFirstPerson(PlayerBase player, PlayerRenderer renderer, ItemInstance itemInstance)
   {
       // 执行第一人称实体渲染逻辑
   }
}

用法与 EntityRenderers 类似

内置饰品渲染器:
CapeRenderer GloveRenderer NecklaceRenderer ConfigurableRenderer

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源