绑定模型到方块和物品

方块模型

方块不直接连接到模型，而是方块状态映射到ModelResourceLocation，它指向模型（“模型”包括方块状态JSON）。 IBlockState由IStateMapper映射到ModelResourceLocation。 默认情况下，所有方块的默认状态映射器的工作原理如下：

  1. 获得方块状态的方块的注册名
  2. 将所述名称设置为ModelResourceLocation的ResourceLocation
  3. 在方块状态中获取所有属性及其值.
  4. 使用IProperty#getNam获取每个属性的名称
  5. 使用IProperty<T>#getName(T)获取每个值的名称
  6. 对属性名称仅按字母顺序对对进行排序
  7. 生成以逗号分隔的键值对字符串(例如a=b,c=d,e=f)
  8. 将其设置为ModelResourceLocation的变体部分。
  9. 如果变量字符串为空（即未定义属性），则将变体默认为normal

变体字符串是自动转成 小写 的，所以如果状态映射器返回mod:model#VARIANT，游戏将查询JSON中的字符串“variant”，而不是“VARIANT”。

自定义IStateMapper

使用自定义的IStateMapper很简单。 获取实例后，可以通过调用ModelLoader.setCustomStateMapper来注册它。 IStateMapper是按每个方块单独注册的，所以这个方法接收IStateMapper和它所处理的方块。其它常见的用例是一个构建器StateMap.Builder。

StateMap.Builder

构建器StateMap.Builder可以创建一些最常见的IStateMapper。 一旦实例化，可以调用方法来设置其参数，并调用build来使用这些参数生成IStateMapper。

withName

withName以一个属性作为参数，并将为返回的ModelResourceLocation设置“名称”（实际上是路径）。 当生成的IStateMapper应用于方块状态时，它用给定属性的值，找到该值的名称，并将其用作资源路径。 看一个例子更清楚：

PropertyDirection PROP_FACING = PropertyDirection.create("facing"); // 创建属性
IStateMapper mapper = new StateMap.Builder().withName(PROP_FACING).build(); // 使用构造器

现在,如果调用 mapper 找方块状态examplemod:block1[facing=east]的 ModelResourceLocation, 它会把它映射到 examplemod:east#normal. 给定examplemod:block2[color=red,facing=north],它会映射到examplemod:north#color=red.

withSuffix

后缀是一个普通字符串，它被添加到资源路径的末尾。 例如，如果后缀设置为_suff，则生成的IStateMapper会将方块状态examplemod:block[facing=east]映射到examplemod:block_suff#facing=east。

ignore

这导致IStateMapper在映射块状态时会简单地忽略给定的属性。 调用两次时，两个列表会合并。 一个例子：

PropertyDirection PROP_OUT = PropertyDirection.create("out");
PropertyDirection PROP_IN = PropertyDirection.create("in");
// 这两个是等价的
IStateMapper together = new StateMap.Builder().ignore(PROP_OUT, PROP_IN).build();
IStateMapper merged = new StateMap.Builder().ignore(PROP_OUT).ignore(PROP_IN).build();

当要求together或merged映射方块状态examplemod:block1[in=north,out=south]时，它们将给出ModelResourceLocation examplemod:block1#normal。 给定examplemod:block2[in=north,out=south,color=blue]，它将产生examplemod:block2#color=blue。 最后，给定examplemod:block3[color=white,out=east]（没有in），它将产生examplemod:block3#color=white。

物品模型

不像方块可以不需注册自动有一个IStateMapper,物品必须手动注册他们的模型,通过调用ModelLoader.setCustomModelResourceLocation.这个方法要一个物品,matedate值,和ModelResourceLocation, 此方法需要传入一个物品，元数据值和ModelResourceLocation，并注册映射，以便所有带有物品和元数据的ItemStack使用给定的模型的ModelResourceLocation。 游戏搜索模型的方式如下：

  1. 对于 ModelResourceLocation <namespace>:<path>#<varstr>
  2. 尝试寻找主动加载该模型的自定义模型加载器
  3. 如果成功,用找到的加载器加载该模型,并跳出该指导.
  4. 如果失败,尝试从方块状态加载器加载.
  5. 如果失败,尝试从原版JSON加载器加载(从assets/<namespace>/models/item/<path>.json加载)

JSON models/item的物品模型可以参考概述.

提示

ModelLoader.setCustomModelResourceLocation也要通过给定的物品和ModelResourceLocation 调用 ModelLoader.registerItemVariants.这为之后的渲染做准备.

ItemMeshDefinition

ItemMeshDefinition是一个函数，它接受ItemStack并将它们映射到ModelResourceLocation。 它们是按物品注册的，这可以通过ModelLoader.setCustomMeshDefinition来完成，它接受一个物品和ItemMeshDefinition用于它的ItemStack。

重要

ModelLoader.setCustomMeshDefinition 不会调用 ModelLoader.registerItemVariants. 因此, 每个ModelResourceLocation都必须传递ModelLoader.registerItemVariants方法，ItemMeshDefinition可以返回它以使其工作。

物品的方块状态JSON

请注意，物品 可以使用 方块状态JSON。 这可以通过简单地将指向块状态JSON的ModelResourceLocation传递给ModelLoader.setCustomModelResourceLocation或从ItemMeshDefinition返回它来实现。 这样做可以让模型利用子模型和组合变体等优点。 两个主要用例是与方块共享模型的物品（特别是ItemBlock）和默认的项层模型（组合变量定义中的textures块可用于构建模型的层，其中一个属性设置layer0，另一个设置layer1等）。

提示

1.9多部分方块状态不能作为开箱即用的物品模型工作，因为它们需要IBlockState来选择模型。

重要

有一个重要的警告。方块状态JSON只能解析models/block下模型的路径; 他们找不到models/item下的模型（即使使用../item也会导致错误）。 这意味着minecraft:item/generated模型（设置项的默认变换）不能在方块状态JSON中使用。 一种解决方法是，使用minecraft:builtin/generated模型，并使用方块状态JSON中的transform标签设置转换。（继承自minecraft:block/block的方块模型已经设置了变换，因此这对他们来说不是必需的。）这是一个例子：

"defaults": {
  "model": "builtin/generated",
  "__comment": "让Forge为玩家手中，地面上等物品设置默认旋转和比例",
  "transform": "forge:default-item"
}