Weather

← Back to Asset Types

Documentation for the Weather asset type.

Location

Weathers

Use in Your Files

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

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

Schema

Tree

Stars stringnull

ScreenEffect stringnull

FogDistance array

Array of strictly two values. First is FogNear, which is expected to be negative. Second is FogFar. FogNear determines how foggy it is at the player's position, while FogFar determines the range at which FogDensities starts ramping up.

Array items: number

FogOptions unknown

Optional extra information about the fog for this Weather

Any of

FogOptions

null

Particle unknown

Any of

WeatherParticle

null

ScreenEffectColors arraynull

Array items: TimeColorAlpha

SunlightDampingMultipliers arraynull

Array items: TimeFloat

SunlightColors arraynull

Array items: TimeColor

SunColors arraynull

Array items: TimeColor

MoonColors arraynull

Array items: TimeColorAlpha

SunGlowColors arraynull

Array items: TimeColorAlpha

MoonGlowColors arraynull

Array items: TimeColorAlpha

SunScales arraynull

Array items: TimeFloat

MoonScales arraynull

Array items: TimeFloat

SkyTopColors arraynull

Array items: TimeColorAlpha

SkyBottomColors arraynull

Array items: TimeColorAlpha

SkySunsetColors arraynull

Array items: TimeColorAlpha

FogColors arraynull

Array items: TimeColor

FogHeightFalloffs arraynull

Array items: TimeFloat

FogDensities arraynull

Array items: TimeFloat

WaterTints arraynull

Array items: TimeColor

ColorFilters arraynull

Array items: TimeColor

Moons arraynull

Array items: DayTexture

Clouds arraynull

Array items: Cloud

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "Weather.json",
  "title": "Weather",
  "description": "Weather asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Stars": {
      "type": [
        "string",
        "null"
      ]
    },
    "ScreenEffect": {
      "type": [
        "string",
        "null"
      ]
    },
    "FogDistance": {
      "type": "array",
      "description": "Array of strictly two values. First is FogNear, which is expected to be negative. Second is FogFar. FogNear determines how foggy it is at the player's position, while FogFar determines the range at which FogDensities starts ramping up.",
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "FogOptions": {
      "description": "Optional extra information about the fog for this Weather",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/FogOptions"
        },
        {
          "type": "null"
        }
      ]
    },
    "Particle": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/WeatherParticle"
        },
        {
          "type": "null"
        }
      ]
    },
    "ScreenEffectColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "SunlightDampingMultipliers": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeFloat"
      }
    },
    "SunlightColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColor"
      }
    },
    "SunColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColor"
      }
    },
    "MoonColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "SunGlowColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "MoonGlowColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "SunScales": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeFloat"
      }
    },
    "MoonScales": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeFloat"
      }
    },
    "SkyTopColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "SkyBottomColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "SkySunsetColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColorAlpha"
      }
    },
    "FogColors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColor"
      }
    },
    "FogHeightFalloffs": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeFloat"
      }
    },
    "FogDensities": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeFloat"
      }
    },
    "WaterTints": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColor"
      }
    },
    "ColorFilters": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/TimeColor"
      }
    },
    "Moons": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/DayTexture"
      }
    },
    "Clouds": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/Cloud"
      }
    }
  }
}