Fabric Wiki

User Tools

Site Tools

Trace:
zh_cn:tutorial:datagen_model

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
zh_cn:tutorial:datagen_model [2025/04/01 15:36] – [为带有朝向的方块] solidblockzh_cn:tutorial:datagen_model [2025/04/18 14:55] (current) – solidblock
Line 1: Line 1:
 ======模型生成====== ======模型生成======
-我们知道，几乎每个物品都需要对应的**物品烘焙模型**（item baked model，以下简称物品模型），从 1.21.4 开始还需要**物品模型映射**（item models definition）。每个方块都需要**方块烘焙模型**（block baked model，以下简称方块模型）和**方块状态映射**（block states definition），还需要对应的物品烘焙模型或者物品模型映射。一个方块就有这么多大大小小复杂的 JSON 要文件。显然，一个个去制作太费神了。因此，我们使用数据生成器为方块和物品生成模型。+我们知道，几乎每个物品都需要对应的**物品烘焙模型**（item baked model，以下简称物品模型），从 1.21.4 开始还需要**物品模型映射**（item models definition）。每个方块都需要**方块烘焙模型**（block baked model，以下简称方块模型）和**方块状态映射**（block states definition），还需要对应的物品烘焙模型或者物品模型映射。一个方块就有这么多大大小小复杂的 JSON 文件。显然，一个个去制作太费神了。因此，我们使用数据生成器为方块和物品生成模型。
  
-在数据生成器中，模型和映射通常是一起生成的，通常来说，生成模型时返回一个模型 id，然后利用这个模型 id 去生成方块状态映射或物品模型映射。我们将从简单到复杂逐个开始。+在数据生成器中，模型和映射通常是一起生成的，通常来说，生成模型时返回一个模型 id，然后利用这个模型 id 会被方块状态映射或物品模型映射使用。我们将从简单到复杂逐个开始。
  
 > :!: **注意：**我们在之前的教程中，在 ''resources'' 文件夹内可能已经手动创建了一些 JSON 文件。当数据生成器生成同名的 JSON 文件时，会与我们已经手动创建的 JSON 冲突，因此在运行数据生成前，请删除它们。 > :!: **注意：**我们在之前的教程中，在 ''resources'' 文件夹内可能已经手动创建了一些 JSON 文件。当数据生成器生成同名的 JSON 文件时，会与我们已经手动创建的 JSON 冲突，因此在运行数据生成前，请删除它们。
  
 +> :!: **注意：**从 1.21.4 开始，数据生成会区分客户端和服务器，原版中与模型有关的类都会被加上 ''@Environment(EnvType.CLIENT)''，仅在客户端环境下可用。如果你在实际运行数据生成时，发现是服务器环境从而报错，请参考[[datagen_setup|数据生成入门教程]]的手动数据生成部分，在 ''build.gradle'' 中修改 ''fabricApi'' 块以启用客户端环境，然后重新生成 IDE 的运行配置。
 ===== 准备 ===== ===== 准备 =====
  
Line 133: Line 134:
 </code> </code>
  
-> 在 1.21.4 及之前的版本中，不需要调用 ''BlockStateModelGenerator.createWeightedVariant'' 方法中，直接将 id 传作参数即可。+> 在 1.21.4 及之前的版本中，不需要调用 ''BlockStateModelGenerator.createWeightedVariant''，直接将 id 传作参数即可。
  
 大功告成！我们就仅仅通过这么几行代码，成功地添加了楼梯和台阶所需要的一切模型、方块状态映射和物品模型映射！ 大功告成！我们就仅仅通过这么几行代码，成功地添加了楼梯和台阶所需要的一切模型、方块状态映射和物品模型映射！
  
-===== 带有朝向的方块 =====+===== 带有朝向的方块（以竖直台阶为例） =====
  
-带有朝向的方块通常仅使用一个方块模型，但是在方块模型映射中，会映射到不同的模型变种，例如不同的 x 旋转、y 旋转以及 uvlock。（这些词在之前手动写方块状态映射的 JSON 时是不是有些熟悉？）+带有朝向的方块通常仅使用一个方块模型，但是在方块状态映射中，会映射到不同的模型变种，例如不同的 x 旋转、y 旋转以及 uvlock。（这些词是不是在之前手动写方块状态映射的 JSON 时有些熟悉？）
  
 我们以 [[directionalblock]] 中创建的竖直台阶为例，通过数据生成器为其生成模型和方块状态映射。 我们以 [[directionalblock]] 中创建的竖直台阶为例，通过数据生成器为其生成模型和方块状态映射。
Line 145: Line 146:
 ==== 自定义模型 ==== ==== 自定义模型 ====
  
-我们之前创建过一个 ''tutorial:block/vertical_slab'' 的模型，作为竖直方块模型的模板。这种模板模型通常不需要使用数据生成器生成。然后我们为竖直的磨制安山岩台阶方块创建了名为 ''tutorial:block/polished_andesite_vertical_slab''，继承前面提到的模板模型，并提供纹理变量。+我们之前创建过一个 ''tutorial:block/vertical_slab'' 的模型，作为竖直台阶方块模型的模板。这种模板模型通常不需要使用数据生成器生成。然后我们为竖直的磨制安山岩台阶方块创建名为 ''tutorial:block/polished_andesite_vertical_slab'' 的模型，继承前面提到的模板模型，并提供纹理变量。
  
 为了在数据生成器中继承此模板模型，我们需要为此模板模型创建 ''Model'' 对象。该模型的 JSON 中会使用 ''bottom''、''top'' 和 ''side'' 这三个纹理变量，因此我们在这里的代码中也依赖这三个纹理变量，数据生成器将在生成模型时为这几个变量赋值。 为了在数据生成器中继承此模板模型，我们需要为此模板模型创建 ''Model'' 对象。该模型的 JSON 中会使用 ''bottom''、''top'' 和 ''side'' 这三个纹理变量，因此我们在这里的代码中也依赖这三个纹理变量，数据生成器将在生成模型时为这几个变量赋值。
Line 173: Line 174:
 重头戏来了——现在我们要为竖直台阶方块创建方块状态映射。其实没那么复杂，因为我们知道模型都是一样的，只需要有不同的旋转而已。 重头戏来了——现在我们要为竖直台阶方块创建方块状态映射。其实没那么复杂，因为我们知道模型都是一样的，只需要有不同的旋转而已。
  
-在 1.21.5 中，方块状态的对象是 ''BlockModelDefinitionCreator''，分为两种：+在 1.21.5 中，方块状态映射是 ''BlockModelDefinitionCreator''，分为两种：
   * ''VariantsBlockModelDefinitionCreator''：根据方块状态分配一个方块模型变种。简单的方块都是用的这种。我们这里所讨论的竖直台阶也是这种。   * ''VariantsBlockModelDefinitionCreator''：根据方块状态分配一个方块模型变种。简单的方块都是用的这种。我们这里所讨论的竖直台阶也是这种。
   * ''MultipartBlockModelDefinitionCreator''：由多个部分组成的方块，每个部分都是一个方块模型变种，每个部分会根据其方块状态来决定是否显示。原版的红石线就是这种。   * ''MultipartBlockModelDefinitionCreator''：由多个部分组成的方块，每个部分都是一个方块模型变种，每个部分会根据其方块状态来决定是否显示。原版的红石线就是这种。
  
 对于 ''VariantsBlockModelDefinitionCreator''，我们需要指定方块状态与方块模型变种的关系，也就是要说清楚：什么方块状态使用什么模型变种。多个方块状态可以使用同一模型变种（例如含水和不含水的方块，模型都是一样的），同一方块状态也可以使用多个变种（例如泥土、沙子等方块的随机旋转）——但必须不重不漏：不一定每个方块状态属性都要考虑到，但每个可能的方块状态都要被包括，且不能重复，否则就会有错误。在 1.21.5 中，有两种方法指定方块状态与模型变种的关系： 对于 ''VariantsBlockModelDefinitionCreator''，我们需要指定方块状态与方块模型变种的关系，也就是要说清楚：什么方块状态使用什么模型变种。多个方块状态可以使用同一模型变种（例如含水和不含水的方块，模型都是一样的），同一方块状态也可以使用多个变种（例如泥土、沙子等方块的随机旋转）——但必须不重不漏：不一定每个方块状态属性都要考虑到，但每个可能的方块状态都要被包括，且不能重复，否则就会有错误。在 1.21.5 中，有两种方法指定方块状态与模型变种的关系：
-  * **方法一**：先指定一个模型变种，然后再根据方块状态修改其变种，如 x 旋转、y 旋转和 uvlock，各方块状态都使用同一模型 id，只是变种可能不同。 +  * **方法一**：先指定一个模型变种，然后再根据方块状态修改其变种，如修改 x 旋转、y 旋转和 uvlock，各方块状态都使用同一模型 id，只是变种可能不同。 
-  * **方法二**：为不同的方块状态分配模型变种。这种情况下，各方块状态可以使用不同的模型 id。+  * **方法二**：直接为不同的方块状态分配模型变种，然后仍可继续根据方块状态修改变种。这种情况下，各方块状态可以使用不同的模型 id。
  
 我们的竖直台阶有两个方块状态属性：''facing'' 和 ''waterlogged''。''waterlogged'' 不影响其模型，所以我们只看 ''facing''。因为模型 id 不受朝向影响，所以这里我们使用方法一。 我们的竖直台阶有两个方块状态属性：''facing'' 和 ''waterlogged''。''waterlogged'' 不影响其模型，所以我们只看 ''facing''。因为模型 id 不受朝向影响，所以这里我们使用方法一。
Line 215: Line 216:
     );     );
 </code> </code>
-> 我们发现，在方法二中，调用 ''VariantsBlockModelDefinitionCreator.of'' 时没有将 ''WeightedVariant'' 作为第二个参数，而是在后面每个方块状态提供一次。通过调用 ''with'' 分配模型变种之后，就可以继续像方法一那样使用 ''apply'' 或 ''coordinate'' 方法修改变种。+> 我们发现，在方法二中，调用 ''VariantsBlockModelDefinitionCreator.of'' 时没有将 ''WeightedVariant'' 作为第二个参数，而是在后面每个方块状态提供一次，我们也注意到方法一中调用的是 ''BlockStateVariantMap.operations''，每次注册的也仅是对模型变种的操作，而在方法二中，调用的是 ''BlockStateVariantMap.models''，每次注册的都是个完整的模型变种。通过调用 ''with'' 分配模型变种之后，就可以继续像方法一那样使用 ''apply'' 或 ''coordinate'' 方法修改变种。 
 + 
 +在上面的方法一和方法二中，除了通过 ''register'' 方法逐个注册模型操作或模型变种之外，也可以使用 ''generate'' 方法，通过 lambda 的方式指定模型操作或者模型变种，这个 lambda 是一个函数，接收对应的属性值作为参数，返回的是模型操作或模型变种。 
 + 
 +如果方块状态有多个可能会影响到模型变种的属性，那么可以直接在 ''BlockStateVariantMap.operations'' 或 ''BlockStateVariantMap.models'' 中提供多个属性，然后在后面调用 ''register'' 或 ''generate'' 时同时指定或使用多个值，也可以调用两次 ''coordinate''，让每个属性各自决定对模型变种的修改。
zh_cn/tutorial/datagen_model.1743521765.txt.gz · Last modified: 2025/04/01 15:36 by solidblock