前置文章:
Minecraft 1.12.2MOD Forge开发帮助文档 (持续更新)
目录
-
-
-
Item类
-
Block类
-
ItemBlock类
-
AxisAlignedBB类
-
BlockRenderLayer类
-
ItemPickaxe类
-
ToolMaterial类
-
ItemStack类
-
IBlockState类
-
CreativeTabs类
-
Material类
-
ItemArmor类
-
ArmorMaterial类
-
GameRegistry类
-
Enchantment类
-
EnchantmentHelper类
-
Rarity类
-
EnumEnchantmentType类
-
EntityEquipmentSlot类
-
SoundEvent类
-
SoundType类
-
Register <T>类
-
IForgeRegistry <T>类
-
ModelLoader类
-
ModelResourceLocation类
-
ResourceLocation类
-
EntityJoinWorldEvent类
-
Entity类
-
EntityPlayer类
-
World类
-
TextComponentString类
-
FurnaceFuelBurnTimeEvent类
-
LivingDeathEvent类
-
LivingDamageEvent类
-
DamageSource类
-
更新中…
-
-
Item类
方法名 | 参数 | 概述 |
---|---|---|
setUnlocalizedName | String | 设置物品的本地化名称,用于.lang语言文件,在游戏中显示得名字 |
setRegistryName | String | 设置物品注册名,如在游戏中/give指令后得名字来得到它 |
setMaxStackSize | int | 设置物品得最大堆叠数 |
setCreativeTab |
CreativeTabs (创造栏选项卡类型) |
把该物品加入到创造模式下创造栏得选项卡中 |
getIiemBurnTime |
ItemStack 堆叠物品类 |
获取物品得燃烧时间 返回int 单位tick 1tick≈50ms |
getRegistryName | 获取物品得注册名 |
Block类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
Material (材料类) |
表示这个方块是由什么材料构成 |
setUnlocalizedName | String | 设置物品的本地化名称,用于.lang语言文件,在游戏中显示得名字 |
setRegistryName | String | 设置物品注册名,如在游戏中/give指令后得名字来得到它 |
setMaxStackSize | int | 设置物品得最大堆叠数 |
setCreativeTab |
CreativeTabs (创造栏选项卡类型) |
把该物品加入到创造模式下创造栏得选项卡中 |
setHarvestLevel |
String(工具类名) (shovel | pickaxe | axe) int(挖掘等级) |
设置可以被更高效率挖掘的工具名和什么材料制作的工具可以挖动 |
setHardness | float | 设置硬度等级 |
isFullCube |
IBlockState (方块状态类) |
返回false表示这不是一个完整填充得方块 |
isOpaqueCube |
IBlockState (方块状态类) |
返回false表示是一个透明得方块 |
getBlockLayer |
获取方块的贴图层 表示贴图层要如何显示 返回 BlockRenderLayer 类 |
|
getSoundType |
获得方块相关的所有声音 返回 SoundType 类 |
|
getBoundingBox |
IBlockState (方块状态类) IBlockAccess BlockPos |
获得方块得碰撞箱 返回 AxisAlignedBB 类 |
ItemBlock类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
Block (材料类) |
通常用于返回实例 return new ItemBlock(Block block) |
getBlock | 获取这个物品方块对应的方块 | |
setRegistryName | String |
设置方块物品得注册名 一般要完整注册一个方块一定要调用此方法注册方块对应的物品方块的名字,注册一个方块不光要注册Block本身,还要注册对应的物品方块 |
AxisAlignedBB类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 | double(X1) double(Y1) double(Z1) double(X2) double(Y2) double(Z2) | 返回一个碰撞箱 X1Y1Z1为相对方块的碰撞箱起点, X2Y2Z2 在mc中一个像素单位为0.0625,所以填参数时最好都写成0.0625 * N的形式 比如一个正常方块的碰撞箱就是(0, 0, 0, 0.0625 * 16, 0.0625 * 16, 0.0625 * 16) |
BlockRenderLayer类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
BlockRenderLayer | SOLID(默认) CUTOUT_MIPPED CUTOUT TRANSLUCENT(含有透明贴图用这个) |
ItemPickaxe类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
ToolMaterial (工具材料类) |
继承它的类需要传入一个ToolMaterial类实例 |
getDestroySpeed |
ItemStack (物品堆叠类型) |
获取破坏速度,用于获取对特定或全部的块的破坏速度 |
ToolMaterial类
方法名 | 参数 | 概述 |
---|---|---|
返回类型为该类型的静态方法
对象 | 方法名 | 参数 | 概述 |
---|---|---|---|
EnumHelper | addToolMaterial | String(名字), int(挖掘等级) , int(耐久) , float(挖掘效率), float(伤害), int(附魔度) | 用于创建一个新的工具材料 |
ItemStack类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
Item (物品类) |
通常用于返回实例 return new ItemStack(Item item) |
构造方法 |
Item (物品类) int |
通常用于返回实例 return new ItemStack(Item item, int amount) |
IBlockState类
方法名 | 参数 | 概述 |
---|---|---|
getBlock | 获取指向这个方块状态的方块 |
CreativeTabs类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 | String | 为这个创造栏选项卡命名 |
getTabIconItem | 返回一个选项卡上的图标(设置选项卡图标) | |
hasSearchBar | 返回true表示在这个创造栏中将显示搜索框 | |
getSearchbarWidth | 返回int 表示搜索框相对位置 | |
getBackgroundImageName |
返回String 如”test.png” 表示设置这个创造栏的背景图片 图片位置例: \src\main\resources\assets\minecraft\textures\gui\ container\creative_inventory\test.png |
Material类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
Material | AIR GRASS GROUND WOOD ROCK IRON ANVIL WATER LAVA LEAVES PLANTS VINE SPONGE CLOTH FIRE SAND CIRCUITS CARPET GLASS REDSTONE_LIGHT TNT CORAL ICE PACKED_ICE SNOW CRAFTED_SNOW CACTUS CLAY GOURD DRAGON_EGG PORTAL CAKE WEB |
ItemArmor类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
ArmorMaterial (盔甲材料类) int(历史遗留 填0) EntityEquipmentSlot(盔甲类型) |
继承该类的构造函数需要super传入这些参数 |
setUnlocalizedName | String | 设置物品的本地化名称,用于.lang语言文件,在游戏中显示得名字 |
setRegistryName | String | 设置物品注册名,如在游戏中/give指令后得名字来得到它 |
setMaxStackSize | int | 设置物品得最大堆叠数 |
setCreativeTab |
CreativeTabs (创造栏选项卡类型) |
把该物品加入到创造模式下创造栏得选项卡中 |
ArmorMaterial类
方法名 | 参数 | 概述 |
---|---|---|
返回类型为该类型的静态方法
对象 | 方法名 | 参数 | 概述 |
---|---|---|---|
EnumHelper | addArmorMaterial |
String(名字), String(材质前缀)
int(耐久基数) int[ ] (防御点数) int(附魔度) int (韧性)(填0) |
用于创建一个新的盔甲材料 |
GameRegistry类
方法名 | 参数 | 概述 |
---|---|---|
addSmelting |
Item (物品类) float |
添加新得熔炉烧练规则 |
Enchantment类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
Rarity (稀有程度类) |
继承附魔类得新附魔需要super这些参数 |
getMaxLevel | 返回int 表示该类附魔效果的最大等级 | |
getMinEnchantability | 返回int 表示该类附魔在附魔台上需要的最小等级 | |
getMaxEnchantability | 返回int 表示该类附魔在附魔台上需要的最大等级 | |
canApplyTogether |
Enchantment (附魔类) |
返回Boolean 返回false表示该附魔不与传进来的参数附魔可同时存在 例:return super.canApplyTogether(ench) && ench != Enchantments.FIRE_PROTECTION指已有此附魔或者存在火抗附魔的物品不能再进行这个附魔 |
EnchantmentHelper类
方法名 | 参数 | 概述 |
---|---|---|
getEnchantmentLevel |
Enchantment (附魔类) |
返回int 表示返回一个含有指定附魔的堆叠物品的附魔等级 |
Rarity类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
Rarity | COMMON UNCOMMON RARE VERY_RARE |
EnumEnchantmentType类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
EnumEnchantmentType | ALL ARMOR ARMOR_FEET ARMOR_LEGS ARMOR_CHEST ARMOR_HEAD WEAPON DIGGER FISHING_ROD BREAKABLE BOW WEARABLE |
EntityEquipmentSlot类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
EntityEquipmentSlot | MAINHAND OFFHAND FEET LEGS CHEST HEAD |
SoundEvent类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
SoundEvents |
属性太多这里放个链接 https://pan.baidu.com/s/1gJkkgsI8Qs5p6_Y5M2OLzA 提取码:GA75 |
SoundType类
方法名 | 参数 | 概述 |
---|---|---|
返回为该类型的属性
对象 | 属性名 |
---|---|
SoundType | WOOD GROUND PLANT STONE METAL GLASS CLOTH SAND SNOW LADDERANVIL SLIME |
Register <T>类
方法名 | 参数 | 概述 |
---|---|---|
getRegistry |
用于获取 IForgeRegistry 类 |
IForgeRegistry <T>类
方法名 | 参数 | 概述 |
---|---|---|
register |
T (T表示传过来得泛型对象) |
注册物品,方块等加入到游戏中 对应的资源文件参考 Minecraft Forge API JOSN资源等帮助文档(1.12.2) (未连接) |
ModelLoader类
方法名 | 参数 | 概述 |
---|---|---|
setCustomModelResourceLocation |
Item (物品类) int |
设置模型资源方法 完成模型的注册 |
ModelResourceLocation类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 |
ResourceLocation (资源位置类) String |
通常用于返回实例 new ModelResourceLocation(ResourceLocation res, String str) |
ResourceLocation类
方法名 | 参数 | 概述 |
---|---|---|
返回类型为该类型的方法
对象 | 方法名 | 参数 | 概述 |
---|---|---|---|
Item |
getRegistryName |
用于获取注册名 对应的资源位置 方块:\src\main\resources\assets{你的ModId}\textures\blocks 物品:\src\main\resources\assets{你的ModId}\textures\tiems 装备在身的盔甲:\src\main\resources\assets{你的ModId}\textures\models\armor |
EntityJoinWorldEvent类
方法名 | 参数 | 概述 |
---|---|---|
getEntity |
用于获取 Entity 类 |
Entity类
方法名 | 参数 | 概述 |
---|---|---|
getName | 获取该实体的名称 | |
sendMessage |
TextComponentString |
用于向对应的实体聊天栏输出信息 |
拥有的属性
属性名 | 类型 | 概述 |
---|---|---|
world |
World |
该实体所处于得世界 |
posX | double | 实体得X坐标 |
posY | double | 实体得Y坐标 |
posZ | double | 实体得Z坐标 |
EntityPlayer类
继承自
Entity
类
方法名 | 参数 | 概述 |
---|---|---|
getHeldItemMainhand |
获得主手得物品 返回主手得堆叠物品类 ItemStack |
World类
方法名 | 参数 | 概述 |
---|---|---|
createExplosion |
Entity (来源实体 如果没有来源填null) double(X坐标), double(Y坐标), double(Z坐标) float(爆炸等级), boolean(是否有爆炸烟雾特效) |
大部分爆炸得产生(如爬行者, TNT, 末影水晶等爆炸都由它产生) |
拥有的属性
属性名 | 类型 | 概述 |
---|---|---|
boolean | isRemote |
处于那个端 false表示在逻辑服务端 true表示在客户端 |
TextComponentString类
方法名 | 参数 | 概述 |
---|---|---|
构造方法 | String | 通常用于返回实例 new TextComponentString(String str) |
FurnaceFuelBurnTimeEvent类
方法名 | 参数 | 概述 |
---|---|---|
getItemStack | 获得触发燃烧事件对应燃料的堆叠物品 |
LivingDeathEvent类
方法名 | 参数 | 概述 |
---|---|---|
getSource |
获得伤害来源类 DamageSource |
|
getEntity |
获得死亡得实体 返回实体类 Entity |
LivingDamageEvent类
方法名 | 参数 | 概述 |
---|---|---|
getSource |
获得伤害来源类 DamageSource |
|
getEntity |
获得受伤得实体 返回实体类 Entity |
DamageSource类
方法名 | 参数 | 概述 |
---|---|---|
getImmediateSource |
获得直接来源 返回实体类 Entity |
更新中…