RandomLib 最初是 One Block Plus 模组的一部分,现在已作为独立的库,允许你的模组为加权随机生成创建配置文件。
开发者文档。(工作中)
(这部分内容稍后可能会被替换为一个 GitHub 仓库)
在 FMLCommonSetupEvent 期间调用 RandomLibUtils.setup 以设置你的配置文件。
<T extends ExtraData> RandomLibUtils.setup(ResourceLocation registryKey, Supplier<T> extra, Consumer<Map<String, RandomPool<T>>> afterDeserialization)
例如,如果registryKey = oneblock:phases,你的配置文件将生成在 configs/oneblock/phases/ 文件夹中。
extra 是一个用于提供ExtraData 实现实例的供应器。这允许你在保存加权物品的同时,存储更多关于随机池的信息。
一旦配置文件被反序列化,它们将以文件名作为键保存在一个 Map 中,但你很可能希望使用afterDeserialization 消费函数将它们存储在你模组中更便捷的结构里。
在 FMLServerStartingEvent 期间调用 RandomLibUtils.registerCommand 以设置一个用于管理由 RandomLib 生成的配置文件的命令。
RandomLibUtils.registerCommand(FMLServerStartingEvent event, String commandname, ResourceLocation registryKey)
RandomLibUtils.registerCommand(FMLServerStartingEvent event, String commandname, ResourceLocation registryKey, ExtraDataCommand<? extends ExtraData> extraDataCommand)
registryKey 与 RandomLibUtils.setup
extraDataCommand 为你的 ExtraData 实现补全 Brigadier。
使用 RandomPool#getExtra() 获取反序列化后的 ExtraData。
使用 RandomPool#getRandom()#generateAndReplace(ServerWorld, BlockPos) 在指定世界的指定位置销毁方块,并从随机池中生成一个物品。
使用 RandomPool#getRandom()#generate(ServerWorld, BlockPos) 在指定世界的指定位置从随机池中生成一个物品。
使用 RandomPool#getRandom()#vgenerate(RandomContainer, ServerWorld, BlockPos, ItemStack) 在指定世界的指定位置,为实现了 RandomContainer 接口的对象(可能是区块实体)以及给定的手持物品(如果有)从随机池中生成一个物品。
用户文档。(进行中)
帮助命令:/<本模组对应的 RandomLib 命令名称> help
示例:

Originally a part of the One Block Plus mod, RandomLib is now a standalone library allowing your mod to create config files for weighted random generation.
Developer documentation. (WIP)
(This will likely be replaced later by a github repository)
RandomLibUtils.setup during FMLCommonSetupEvent to setup your config files.
<T extends ExtraData> RandomLibUtils.setup(ResourceLocation registryKey, Supplier<T> extra, Consumer<Map<String, RandomPool<T>>> afterDeserialization)
As an example, your config files will be generated in configs/oneblock/phases/ folder if registryKey = oneblock:phases.
extra is a supplier for an instance of an ExtraData implementation. This allows you to save more information about a random pool, in addition to the weighted items.
Once your config files are deserialized, they are saved in a map with their file name as a key but you likely would like to store them in a more convenient structure for your mod using the afterDeserialization consumer.
RandomLibUtils.registerCommand during FMLServerStartingEvent to setup a command to manage config files generated by RandomLib.
RandomLibUtils.registerCommand(FMLServerStartingEvent event, String commandname, ResourceLocation registryKey)
RandomLibUtils.registerCommand(FMLServerStartingEvent event, String commandname, ResourceLocation registryKey, ExtraDataCommand<? extends ExtraData> extraDataCommand)
registryKey is the same as for RandomLibUtils.setup
extraDataCommand completes brigadier for your ExtraData implementation.
RandomPool#getExtra() to get your deserialized ExtraData.
RandomPool#getRandom()#generateAndReplace(ServerWorld, BlockPos) to destroy block and generate an item from the random pool in the given world at the given position.
RandomPool#getRandom()#generate(ServerWorld, BlockPos) to generate an item from the random pool in the given world at the given position.
RandomPool#getRandom()#vgenerate(RandomContainer, ServerWorld, BlockPos, ItemStack) to generate an item from the random pool for an object implementing RandomContainer (likely a tile entity) in the given world at the given position and for the given held item (if any).
User documentation. (WIP)
Help command : /<RandomLib command name for this mod> help
example:

评论 0
登录后参与评分
还没有评论,来抢沙发吧