Environment

← Back to Asset Types

Documentation for the Environment asset type.

Location

Environments

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/Environment.schema.json" Copy

Schema

Tree

WaterTint unknown

Any of

string

string

null

FluidParticles objectnull

Additional properties: FluidParticle

SpawnDensity number

Default:0

BlockModificationAllowed boolean

Default:true

WeatherForecasts object

Additional properties: array

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "Environment.json",
  "title": "Environment",
  "description": "Environment asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "WaterTint": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^\\s*#([0-9a-fA-F]{3}){1,2}\\s*$"
        },
        {
          "type": "string",
          "pattern": "^\\s*rgb\\((\\s*[0-9]{1,3}\\s*,){2}\\s*[0-9]{1,3}\\s*\\)\\s*$"
        },
        {
          "type": "null"
        }
      ]
    },
    "FluidParticles": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "common.schema.json#/$defs/FluidParticle"
      }
    },
    "SpawnDensity": {
      "type": "number",
      "default": 0
    },
    "BlockModificationAllowed": {
      "type": "boolean",
      "default": true
    },
    "WeatherForecasts": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "title": "WeightedMap",
        "items": {
          "$ref": "common.schema.json#/$defs/WeatherForecast"
        }
      },
      "propertyNames": {
        "description": "A string that contains any integer",
        "pattern": "^[0-9]+$",
        "enum": [
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9",
          "10",
          "11",
          "12",
          "13",
          "14",
          "15",
          "16",
          "17",
          "18",
          "19",
          "20",
          "21",
          "22",
          "23"
        ]
      }
    }
  }
}