Temporal API

模组

· 作者 CyberRat2

Temporal API 是 Team Temporal 模组的库,其他项目也可能使用它。

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

最新 1.6.6 · 1.20.6 · Forge

一键开服(送7天)

Temporal API 是 Team Temporal 官方库。其他模组、模组作者和整合包制作者可以随意将其用于自己的项目中。

本模组的主要目标是让模组的创建变得更加简单和灵活!

要使用我们的库,你需要前往 build.gradle 并添加以下内容:

repositories {
    maven {
        url "https://cursemaven.com"
    }
}

dependencies {
    implementation fg.deobf("curse.maven:temporalapi-970291:<file-id>")
    
    ...
}

你需要将 <file id> 替换为所需版本模组文件链接末尾的文件 ID。

当前状态的库提供了以下功能:

工厂方法(Factories), 标签工具(Tag utils), 创造模式标签页工具(Creative tab utils), 村民与流浪商人交易自定义器(Trading with villagers and wanderers customizer), 世界特性工具(World features utils), 物品属性工具(Item properties utils), 视野范围修改器(Fov modifier) 等等。

工厂方法与扩展 工厂方法用于创建 RegistryObject 对象,使它们的创建过程更加轻松。

要从 API 中使用 ItemFactory,你需要创建一个类似如下的 ItemFactoryFacade 类:

public class ModItemFactoryFacade extends ItemFactory {
    public ModItemFactoryFacade() {
        super(ModItems.ITEMS);
    }
}

此外,你还可以从 API 中扩展你的 Factory Facade 以包含 Extensions,或者创建你自己的 Extension。

以下是两种使用 SwordExtension 的示例(通过此 Extension,剑的创建变得容易得多):

像这样:

public class ModItemFactoryFacade extends ItemFactory implements SwordExtension {
    public ModItemFactoryFacade() {
        super(ModItems.ITEMS);
    }
}

或者像这样:

public class ModItemFactoryFacade extends ItemFactory implements SwordExtension {
    public ModItemFactoryFacade() {
        super(ModItems.ITEMS);
    }

    public RegistryObject<SwordItem> createSword(String name, Object... args) {
        return SwordExtension.super.createSword(name, this, args);
    }

    public RegistryObject<? extends SwordItem> createSword(String name, Supplier<? extends SwordItem> tTypedSupplier) {
        return SwordExtension.super.createSword(name, this, tTypedSupplier);
    }
}

那么如何使用这个 Facade 类来创建我们的对象呢?

public class ModItems {
    public static final DeferredRegister<Item> ITEMS = DeferredRegister.create(Registries.ITEM, "MOD_ID");
    public static final ModItemFactoryFacade ITEM_FACTORY = new ModItemFactoryFacade();

    public static final RegistryObject<Item> MY_ITEM_1 = ITEM_FACTORY.create("my_item_1");
    public static final RegistryObject<Item> MY_ITEM_2 = ITEM_FACTORY.create("my_item_2", new Item.Properties());
    public static final RegistryObject<Item> MY_ITEM_3 = ITEM_FACTORY.create("my_item_3", () -> new Item(new Item.Properties()));

    // 上方第一个示例:从 Facade 对象创建
    public static final RegistryObject<SwordItem> MY_SWORD_1 = ITEM_FACTORY.createSword("my_sword_1", ITEM_FACTORY, Tiers.STONE, 3, -2.4F);
    public static final RegistryObject<? extends SwordItem> MY_SWORD_2 = ITEM_FACTORY.createSword("my_sword_2", ITEM_FACTORY, () -> new SwordItem(Tiers.STONE, 3, -2.4F, new Item.Properties()));


    // 上方第二个示例:从 Facade 对象创建
    public static final RegistryObject<SwordItem> MY_SWORD_3 = ITEM_FACTORY.createSword("my_sword_3", Tiers.STONE, 3, -2.4F);
    public static final RegistryObject<? extends SwordItem> MY_SWORD_4 = ITEM_FACTORY.createSword("my_sword_4", () -> new SwordItem(Tiers.STONE, 3, -2.4F, new Item.Properties()));
}

现在让我们看看 args... 数组。它是用于创建对象的参数数组(未来将会更改以提高可读性)。

目前可用的工厂方法和扩展:

ItemFactory (ArrowExtension, BowExtension, BowlExtension, MusicDiscExtension, SmithingTemplateExtension, SwordExtension, AxeExtension, PickaxeExtension, ShovelExtension, HoeExtension)
BlockFactory (BushExtension, FlowerExtension, PottedFlowerExtension)
ParticleFactory
EffectFactory
PaintingFactory
PotionFactory
SoundEventFactory
CreativeTabFactory
EntityFactory
标签工具
标签工具专注于标签的创建以及简化标签的使用。

例如,如果你想创建物品标签,你需要使用 ItemTagFactory:

public class MyItemTags {
    public static final TagFactory<Item> TAG_FACTORY = new ItemTagFactory("MY_MOD_ID");

    public static final TagKey<Item> MY_TAG = TAG_FACTORY.createTag("my_tag");
}
创造模式标签页工具
创造模式标签页工具用于将物品添加到你需要的创造模式标签页中。

首先,我们需要进入订阅模组事件的那个类,并添加以下函数(方法内部的内容仅为示例):

@SubscribeEvent
public void addCreativeTabs(BuildCreativeModeTabContentsEvent event) {
    new SimpleTabAdder(event)
            .addAllToTab(CreativeModeTabs.INGREDIENTS, ModItems.MY_ITEM_1, ModItems.MY_ITEM_2, ModItems.MY_ITEM_3)
            .addAllToTab(CreativeModeTabs.COMBAT, ModItems.MY_SWORD_1, ModItems.MY_SWORD_2, ModItems.MY_SWORD_3);
}

村民与流浪商人交易工具 TemporalAPI 使交易变得非常容易。以下是其示例:

public static final TradeCustomizer tradeCustomizer = new SimpleTradeCustomizer();

@SubscribeEvent
public void customizeTradesWithVillagers(VillagerTradesEvent event) {
    tradeCustomizer.customize(event, new VillagerTrade(
            new TradingItemHolder(Items.ANDESITE, 2),
            new TradingItemHolder(Items.EMERALD, 3),
            new VillagerTradeDescription(
                    VillagerProfession.ARMORER, 1, 5, 5, 0.5f
            )
    ));
}

@SubscribeEvent
public void customizeTradesWithWanderers(WandererTradesEvent event) {
    tradeCustomizer.customize(event, new WandererTrade(
            new TradingItemHolder(Items.ANDESITE, 2),
            new TradingItemHolder(Items.EMERALD, 3),
            new WandererTradeDescription(
                    WandererTradeDescription.TradeRarity.RARE, 5, 5, 0.5f
            )
    ));
}

世界特性工具 将在后续更新中扩展。

物品属性工具 为弓、盾牌等添加所需的属性。

@SubscribeEvent
public void clientSetup(final FMLClientSetupEvent event) {
    event.enqueueWork(() -> {
        TemporalItemProperties.makeBow(ModItems.MY_BOW_1);
        TemporalItemProperties.makeShield(ModItems.MY_SHIELD_1);
        TemporalItemProperties.makeCrossbow(ModItems.MY_CROSSBOW_1);
        TemporalItemProperties.putCompostable(ModBlocks.MY_FLOWER_1, 4);
    });
}

常见问题:

这个模组会有 Fabric 版本吗?: 不会,目前没有计划制作 Fabric 版本。

我可以在我的整合包中使用这个模组吗?: 可以,请随意在任何整合包中使用此模组!

如何建议功能或报告 Bug: 加入上方的 Discord 服务器,提出任何评论、问题、建议或反馈!

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源