bedrock-samples/metadata/json_schemas/client_server/world/1.21.20/JigsawStructure.json

{
  "$id": "1007525655",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "1088251937": {
      "description": "Filters allow data objects to specify test criteria which allows their use. Filters can be defined by a single object of type (Filter Test), an array of tests, collection groups, or a combination of these objects.",
      "oneOf": [
        {
          "$ref": "#/definitions/4150989894"
        },
        {
          "items": {
            "$ref": "#/definitions/1088251937",
            "description": "Filters allow data objects to specify test criteria which allows their use. Filters can be defined by a single object of type (Filter Test), an array of tests, collection groups, or a combination of these objects."
          },
          "type": "array"
        },
        {
          "properties": {
            "AND": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates all tests in the group, all must pass in order for the group to pass."
            },
            "NOT": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates all tests in the group, all must fail in order for the group to pass."
            },
            "OR": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates tests in the group, one or more must pass in order for the group to pass."
            },
            "all": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates all tests in the group, all must pass in order for the group to pass."
            },
            "all_of": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates all tests in the group, all must pass in order for the group to pass."
            },
            "any": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates tests in the group, one or more must pass in order for the group to pass."
            },
            "any_of": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates tests in the group, one or more must pass in order for the group to pass."
            },
            "none_of": {
              "$ref": "#/definitions/1088251937",
              "description": "Evaluates all tests in the group, all must fail in order for the group to pass."
            }
          },
          "type": "object"
        }
      ],
      "title": "Filter Group"
    },
    "1292959213": {
      "description": "Identifier of the Jigsaw Structure.",
      "properties": {
        "identifier": {
          "$ref": "#/definitions/3715072987"
        }
      },
      "required": [
        "identifier"
      ],
      "title": "JigsawDescriptionIdentifier",
      "type": "object"
    },
    "1356053607": {
      "title": "Reference",
      "type": "string"
    },
    "169701669": {
      "description": "Pool alias for a Random list of targets",
      "properties": {
        "alias": {
          "description": "Alias of Random Pool",
          "type": "string"
        },
        "targets": {
          "description": "List of potential pools",
          "items": {
            "$ref": "#/definitions/1715022163",
            "description": "Weighted Random Item"
          },
          "type": "array"
        }
      },
      "required": [
        "alias",
        "targets"
      ],
      "title": "RandomPoolAlias",
      "type": "object"
    },
    "1715022163": {
      "description": "Weighted Random Item",
      "properties": {
        "data": {
          "$ref": "#/definitions/1356053607",
          "description": "Item's data"
        },
        "weight": {
          "description": "Weight of item",
          "type": "integer"
        }
      },
      "required": [
        "data",
        "weight"
      ],
      "title": "JigsawTemplatePool",
      "type": "object"
    },
    "2155635173": {
      "description": "Weighted Random Item",
      "properties": {
        "data": {
          "description": "Item's data",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/3138104923",
                "description": "Pool alias for a Direct target."
              },
              {
                "$ref": "#/definitions/169701669",
                "description": "Pool alias for a Random list of targets"
              }
            ]
          },
          "type": "array"
        },
        "weight": {
          "description": "Weight of item",
          "type": "integer"
        }
      },
      "required": [
        "data",
        "weight"
      ],
      "title": "RandomGroupBindings",
      "type": "object"
    },
    "2375908812": {
      "description": "Pool alias for a RandomGroup of aliases",
      "properties": {
        "groups": {
          "description": "Aliases for a RandomGroup",
          "items": {
            "$ref": "#/definitions/2155635173",
            "description": "Weighted Random Item"
          },
          "type": "array"
        }
      },
      "required": [
        "groups"
      ],
      "title": "RandomGroupPoolAlias",
      "type": "object"
    },
    "2427056231": {
      "description": "Uniform distribution of possible anchor points",
      "properties": {
        "max": {
          "description": "Max value of the uniform distribution",
          "oneOf": [
            {
              "$ref": "#/definitions/4201740570",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4235442903",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4202034760",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4235737093",
              "description": "Specifies the vertical anchor"
            }
          ]
        },
        "min": {
          "description": "Min value of the uniform distribution",
          "oneOf": [
            {
              "$ref": "#/definitions/4201740570",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4235442903",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4202034760",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4235737093",
              "description": "Specifies the vertical anchor"
            }
          ]
        },
        "type": {
          "const": "uniform",
          "enum": [
            "uniform",
            "constant"
          ],
          "title": "HeightProviderType",
          "type": "string"
        }
      },
      "required": [
        "max",
        "min",
        "type"
      ],
      "title": "UniformHeightProviderType",
      "type": "object"
    },
    "2580189731": {
      "description": "Max distances from the jigsaw pieces to the structure start",
      "oneOf": [
        {
          "maximum": 128,
          "minimum": 1,
          "type": "integer"
        },
        {
          "properties": {
            "horizontal": {
              "description": "The max distance on the horizontal plane (XZ): [1-128]",
              "maximum": 128,
              "minimum": 1,
              "type": "integer"
            },
            "vertical": {
              "description": "The max distance on the vertical axis (Y). Defaults to no limit.",
              "maximum": 2147483647,
              "minimum": 1,
              "type": "integer"
            }
          },
          "required": [
            "horizontal"
          ],
          "type": "object"
        }
      ],
      "title": "MaxDistanceFromCenter"
    },
    "3138104923": {
      "description": "Pool alias for a Direct target.",
      "properties": {
        "alias": {
          "description": "Alias of Direct pool",
          "type": "string"
        },
        "target": {
          "$ref": "#/definitions/1356053607",
          "description": "Target pool"
        }
      },
      "required": [
        "alias",
        "target"
      ],
      "title": "DirectPoolAlias",
      "type": "object"
    },
    "3176878115": {
      "description": "Constant anchor point",
      "properties": {
        "type": {
          "const": "constant",
          "enum": [
            "uniform",
            "constant"
          ],
          "title": "HeightProviderType",
          "type": "string"
        },
        "value": {
          "description": "Constant anchor point",
          "oneOf": [
            {
              "$ref": "#/definitions/4201740570",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4235442903",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4202034760",
              "description": "Specifies the vertical anchor"
            },
            {
              "$ref": "#/definitions/4235737093",
              "description": "Specifies the vertical anchor"
            }
          ]
        }
      },
      "required": [
        "type",
        "value"
      ],
      "title": "ConstantHeightProviderType",
      "type": "object"
    },
    "3715072987": {
      "title": "Identifier",
      "type": "string"
    },
    "4150989894": {
      "properties": {
        "domain": {
          "description": "The domain the test should be performed in.",
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "string"
            }
          ]
        },
        "operator": {
          "description": "The comparison to apply with 'value'.",
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "string"
            }
          ]
        },
        "subject": {
          "description": "The subject of this filter test.",
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "string"
            }
          ]
        },
        "test": {
          "description": "The name of the test to apply.",
          "type": "string"
        },
        "value": {
          "description": "The value being compared with the test.",
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "string"
            }
          ]
        }
      },
      "required": [
        "test"
      ],
      "title": "Filter Test",
      "type": "object"
    },
    "4201740570": {
      "description": "Specifies the vertical anchor",
      "properties": {
        "absolute": {
          "description": "Offset from anchored vertical position",
          "type": "integer"
        }
      },
      "required": [
        "absolute"
      ],
      "title": "AnchorAbsolute",
      "type": "object"
    },
    "4202034760": {
      "description": "Specifies the vertical anchor",
      "properties": {
        "below_top": {
          "description": "Offset from anchored vertical position",
          "type": "integer"
        }
      },
      "required": [
        "below_top"
      ],
      "title": "AnchorBelowTop",
      "type": "object"
    },
    "4235442903": {
      "description": "Specifies the vertical anchor",
      "properties": {
        "above_bottom": {
          "description": "Offset from anchored vertical position",
          "type": "integer"
        }
      },
      "required": [
        "above_bottom"
      ],
      "title": "AnchorAboveBottom",
      "type": "object"
    },
    "4235737093": {
      "description": "Specifies the vertical anchor",
      "properties": {
        "from_sea": {
          "description": "Offset from anchored vertical position",
          "type": "integer"
        }
      },
      "required": [
        "from_sea"
      ],
      "title": "AnchorFromSea",
      "type": "object"
    },
    "781829906": {
      "description": "Specifies the padding for the top and bottom of the world",
      "properties": {
        "bottom": {
          "description": "The padding from the bottom of the world",
          "type": "integer"
        },
        "top": {
          "description": "The padding from the top of the world",
          "type": "integer"
        }
      },
      "title": "DimensionPaddingRange",
      "type": "object"
    }
  },
  "description": "A Jigsaw Structure is a group of Structure Templates that make up a larger structure.Jigsaw Structures are placed during world generation.",
  "properties": {
    "biome_filters": {
      "$ref": "#/definitions/1088251937",
      "description": "Biomes in which the Jigsaw Structure can generate."
    },
    "description": {
      "$ref": "#/definitions/1292959213",
      "description": "Identifier of the Jigsaw Structure."
    },
    "dimension_padding": {
      "description": "Dimension padding prevents the structure from getting cut off at the top or bottom of the world.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "$ref": "#/definitions/781829906",
          "description": "Specifies the padding for the top and bottom of the world"
        }
      ]
    },
    "heightmap_projection": {
      "description": "Heightmap used to calculate the relative start height. For example, a heightmap_projection of ocean_floor and a start_height of 10 means the Jigsaw Structure will begin generating 10 blocks above the ocean floor. Defaults to 'none'",
      "enum": [
        "world_surface",
        "ocean_floor",
        "none"
      ],
      "title": "HeightmapProjection",
      "type": "string"
    },
    "liquid_settings": {
      "description": "How to handle waterloggable blocks overlapping with existing liquid.",
      "enum": [
        "apply_waterlogging",
        "ignore_waterlogging"
      ],
      "title": "LiquidSettings",
      "type": "string"
    },
    "max_depth": {
      "description": "The maximum recursion depth for Jigsaw Structure Generation. For example, a Jigsaw Structure that builds a road with a max_depth of 5 will only have paths that are a maximum of 5 structures templates in length in any given direction from the origin.",
      "maximum": 20,
      "minimum": 0,
      "type": "integer"
    },
    "max_distance_from_center": {
      "$ref": "#/definitions/2580189731",
      "description": "The max distances on the horizontal plane and optionally the vertical axis from the jigsaw pieces to the structure start."
    },
    "pool_aliases": {
      "description": "Pool Aliases are used to determine which template pool can be a substitute.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/definitions/3138104923",
            "description": "Pool alias for a Direct target."
          },
          {
            "$ref": "#/definitions/169701669",
            "description": "Pool alias for a Random list of targets"
          },
          {
            "$ref": "#/definitions/2375908812",
            "description": "Pool alias for a RandomGroup of aliases"
          }
        ]
      },
      "type": "array"
    },
    "start_height": {
      "description": "Height at which the Jigsaw Structure's start pool should begin.",
      "oneOf": [
        {
          "$ref": "#/definitions/2427056231",
          "description": "Uniform distribution of possible anchor points"
        },
        {
          "$ref": "#/definitions/3176878115",
          "description": "Constant anchor point"
        }
      ]
    },
    "start_jigsaw_name": {
      "description": "The start jigsaw name is the name of the jigsaw block from the start pool to be placed first.",
      "type": "string"
    },
    "start_pool": {
      "$ref": "#/definitions/1356053607",
      "description": "The first Template Pool to use when generating the Jigsaw Structure."
    },
    "step": {
      "description": "Species the world generation phase in which the structure is generated.",
      "enum": [
        "raw_generation",
        "lakes",
        "local_modifications",
        "underground_structures",
        "surface_structures",
        "strongholds",
        "underground_ores",
        "underground_decoration",
        "fluid_springs",
        "vegetal_decoration",
        "top_layer_modification"
      ],
      "title": "GenerationStep",
      "type": "string"
    },
    "terrain_adaptation": {
      "description": "How the terrain should adapt relative to the generated Jigsaw Structure.",
      "enum": [
        "none",
        "bury",
        "beard_thin",
        "beard_box",
        "encapsulate"
      ],
      "title": "TerrainAdaptation",
      "type": "string"
    }
  },
  "required": [
    "description",
    "max_depth",
    "start_height",
    "start_pool",
    "step"
  ],
  "title": "JigsawStructure",
  "type": "object",
  "x-format-version": "1.21.20"
}