HytaleDocs

Weathers

Asset path: Server/Weathers/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another Weather most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Stars

Type information: (Nullable) String

Reference to a common asset in the folder:

  • Common/Sky/

with the extension: *.png

ScreenEffect

Type information: (Nullable) String

Reference to a common asset in the folder:

  • Common/ScreenEffects/

with the extension: *.png

FogDistance

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.

Type information: Array of Number

FogOptions

Optional extra information about the fog for this Weather

Type information:

(Nullable)

FogOptions with the following properties:

KeyTypeDescription
IgnoreFogLimitsBoolean defaults to: false

The client has a default minimum AND maximum for "FogFar". Toggling this on will allow your FogDistance[1] to bypass those limits.

EffectiveViewDistanceMultiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The client's default cap for FogDistance[1] (aka FogFar) is the effective view distance, meaning the farthest viewable chunk. This value (defaults 1.0) multiplies that cap. For example with high fog density, you can afford a fog multiplier of 1.3 as the cutoff of unloaded chunks may still be hidden.

FogHeightCameraFixed(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$

By default, the client has e^(-FogHeightFalloff * ~Camera.Y) height-based fog. This adds significant fog near Camera.Y = 0. By setting this value (between 0.0 and 1.0), the Exp function is bypassed and there will be a fixed fog for height in the fog shader.

FogHeightCameraOffset(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

By default, the client has e^(-FogHeightFalloff * ~Camera.Y) height-based fog. This adds significant fog near Camera.Y = 0. The FogHeightCameraOffset is added to the Camera.Y.

Particle

Type information:

(Nullable) Particle System that can be spawned in relation to a weather.

WeatherParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

The colour used if none was specified in the particle settings.

Scale(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The scale of the particle system.

OvergroundOnlyBoolean defaults to: false

Sets if the particles can only spawn above the columns highest blocks.

PositionOffsetMultiplier(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The amount the system will move ahead of the camera.

ScreenEffectColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

SunlightDampingMultipliers

Type information:

(Nullable) Array of the type:

TimeFloat with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
ValueNumber defaults to: 0.0

SunlightColors

Type information:

(Nullable) Array of the type:

TimeColor with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

SunColors

Type information:

(Nullable) Array of the type:

TimeColor with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

MoonColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

SunGlowColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

MoonGlowColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

SunScales

Type information:

(Nullable) Array of the type:

TimeFloat with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
ValueNumber defaults to: 0.0

MoonScales

Type information:

(Nullable) Array of the type:

TimeFloat with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
ValueNumber defaults to: 0.0

SkyTopColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

SkyBottomColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

SkySunsetColors

Type information:

(Nullable) Array of the type:

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

FogColors

Type information:

(Nullable) Array of the type:

TimeColor with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

FogHeightFalloffs

Type information:

(Nullable) Array of the type:

TimeFloat with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
ValueNumber defaults to: 0.0

FogDensities

Type information:

(Nullable) Array of the type:

TimeFloat with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
ValueNumber defaults to: 0.0

WaterTints

Type information:

(Nullable) Array of the type:

TimeColor with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ColorFilters

Type information:

(Nullable) Array of the type:

TimeColor with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

Moons

Type information:

(Nullable) Array of the type:

DayTexture with the following properties:

KeyTypeDescription
DayInteger defaults to: 0
Texture(Nullable) String

Reference to a common asset in the folder:

  • Common/Sky/
with the extension: *.png

Clouds

Type information:

(Nullable) Array of the type:

Cloud with the following properties:

KeyTypeDescription
Texture(Nullable) String

Reference to a common asset in the folder:

  • Common/Sky/
with the extension: *.png
Colors(Nullable) Array of the type:
TimeColorAlpha

TimeColorAlpha with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
Color(Nullable) A color in the form:

  • #RRGGBBAA

  • rgba(rrr, ggg, bbb, a.a)

  • rgba(#RRGGBB, a.a)

Speeds(Nullable) Array of the type:
TimeFloat

TimeFloat with the following properties:

KeyTypeDescription
HourNumber defaults to: 0.0
ValueNumber defaults to: 0.0

On this page