heatClimate.assetType
- README.md2.1 KB
- about.yaml697 B
- behavior.luau587 B
- type.yaml878 B
README.md
heatClimate (asset type)
The weather and time of day heat sits in. A climate sets how warm the air, the ground, the sky and water are, whether the sun is up and warming what it reaches, and the temperature range a thermal palette spans, so the same scene reads as a cold night, a hot desert or a steaming factory. heatSignatures ships five: temperateNight, desertDay, arctic, factory and horrorLair.
local Heat = require("~heatSignatures.Heat")
Heat.setClimate("desertDay") -- every player, saved with the scene's HeatClimate entity
Heat.setClimate("temperateNight", { air = 2 }) -- with overrides
for _, c in Heat.climates() do print(c.id, c.name) end
Folder shape
desertDay.heatClimate/
climate.yaml the climate (required)
README.md what place and time it is, how things read in it (required)
.metadata { "tags": ["climate", "desert"] } (required)
climate.yaml
name: "Desert day"
summary: "Midday sun on sand and rock: the ground hotter than the people on it."
air: 38 # degrees C
ground: 52 # flat ground in the open
sky: -10 # what a camera pointed at the sky reads
water: 24
plant: -6 # foliage relative to air (transpiration keeps leaves cooler)
sunWarm: 14 # extra warming on surfaces facing the sun, dark ones more
skyCool: -2 # cooling on surfaces facing an open sky at night
day: 1 # 0 night, 1 full day
sun: [0.3, 0.9, 0.2]
low: 15 # the range a thermal palette spans by default
high: 70
glow: 60 # extra heat where the picture glows (flames, bulbs)
glowAt: 0.85 # how bright a pixel must be to count as glowing
detail: 1 # how much surface colour varies the temperature
Every value is optional; a missing one takes the temperate night's.
Known limits
- An asset of this type registers when the engine indexes its files, a moment after they are written;
Heat.climates()reads them again every few seconds. - The heatSignatures package README's Known limits lists the rest.