# 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`.
```luau
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
```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.
# heatSignatures
heatSignatures was called heatKit until 1.0.6; code that required `~heatKit.Heat` now requires `~heatSignatures.Heat`.
Things in your world have their own heat, for a thermal camera to draw and for gameplay to read: people and animals warm, engines and fires hot, metal and water cold, with good defaults found from entity names so a scene reads right without tagging everything.
Install heatSignatures for a heat signature on everything: a thermal vision or thermal scope look (with sensorBlocks), a guard who spots you by your body heat in a stealth game, a heat-seeking missile, a cold zone that freezes the player, or a warm hand print on a door that gives away where someone went in a horror game. Every temperature is in degrees Celsius, the same on every player's machine.
## Five minutes to a sensor look on your own scene
1. **Install.** Search ZeroMind for `heatSignatures` (or "heat signature for thermal camera") and install the package. For the picture, install `sensorBlocks` too (search "thermal vision night vision sensor look"); for goggles a player wears, `sensorGoggles`. styleKit comes with them.
2. **Look at the defaults.** Most scenes already read: anything named `Guard`, `Soldier`, `Person`, `Fox`, `Dog`, `Campfire`, `Torch`, `Generator`, `Engine`, `Car`, `Lamp`, `Server`, `Crate`, `Barrel`, `Stream`, `Ice` and many more gets its class, and every player's body is a warm person.
```luau
local Heat = require("~heatSignatures.Heat")
for _, s in Heat.sources() do print(s.class, s.origin, s.temp) end
```
3. **Pick the weather.**
```luau
Heat.setClimate("desertDay") -- or temperateNight, arctic, factory, horrorLair
```
4. **Give heat where the names miss.**
```luau
entity.find("Reactor").component.add("heatSignatures.HeatSource", { class = "engine", working = true })
Heat.addRule("robot", "electronics") -- every Robot1, Robot2... from now on
```
5. **See it.**
```luau
local Sensors = require("~sensorBlocks.Sensors")
Sensors.use("militaryThermal")
```
6. **Use it in play.**
```luau
if Heat.at(player.position) < 0 then print("freezing") end
print(Heat.of(entity.find("Guard1"))) -- about 33 C, warmer while running
Heat.touch(handPoint) -- a warm print that fades over 30 s
```
## What is inside
| Asset | What it is |
|---|---|
| `Heat` module | The temperature model: `Heat.at`, `Heat.of`, `Heat.give` / `Heat.take`, `Heat.touch`, `Heat.setClimate` / `Heat.climate` / `Heat.climates`, `Heat.addRule`, `Heat.classForName`, `Heat.setAuto`, `Heat.sources`, `Heat.prints`, `Heat.CLASSES`, `Heat.DEFAULT_RULES`. |
| `HeatSource` component | Synced: gives one object its own class, temperature, running temperature, `working` switch and warm-up time. |
| `HeatClimate` component | Synced: the scene's climate and overrides (made for you by `Heat.setClimate`). |
| `HeatField` module + `heatField` render feature | Per machine: packs the climate and the 64 nearest heat shapes into a data texture each frame and publishes it to styleKit as the `heat` input. |
| `heatField` shader module | `hk_temp(uv)`: the temperature of what each pixel shows, in degrees C, for style blocks. |
| `heatClimate` asset type | A climate as a `climate.yaml` (air, ground, sky, water, sun, palette range). |
| `climates/` | `temperateNight`, `desertDay`, `arctic`, `factory`, `horrorLair`. |
| `guides/how-to-give-things-heat.guide` | How to give things heat for a thermal camera or gameplay. |
### The classes
person 33 C (35.5 running), animal 36 C, engine ambient off and 90 C running, vehicle 20 C warming to 60 C as it drives, fire 420 C with radiant warmth around it, lamp 70 C, electronics 32 to 45 C, metal and stone just under the air (metal has low emissivity, so it mirrors the cold sky and reads cold), water at the climate's water temperature, ice -6 C, plant near the air, and plain warm and cold. Moving or working things warm up over their `warmUp` seconds and cool at half that speed.
### How surfaces read
Ground and walls take the climate's ground or air by their facing, warmed where the sun reaches them (dark colours more) and cooled under an open night sky. Green surfaces read as leaves, near the air. Pixels that glow (flames, bulbs, day-glo paint) read hot.
## Stacking with Style Cookbook blocks
heatSignatures draws nothing by itself; sensorBlocks' thermal blocks read it. They sit in styleKit's Colour slot, so a Cookbook ink line, film grain, paper or vignette already in the scene stays in the stack under or over the sensor look, and `Sensors.off()` gives the scene's own look back. Your own blocks can read the heat too: add `"input:heat"` and `"input:heatObj"` to `reads`, declare `in_heat` and `in_heatObj` textures, and include `~heatSignatures.shaders.heatField`.
## Multiplayer
- **Shared by everyone**: the climate (a synced HeatClimate entity), HeatSource components and their `working` switch, warm prints from `Heat.touch` (sent to every player), and the heat found from names and players' bodies (every machine walks the same scene and finds the same).
- **Per machine**: the data texture and the picture, and `Heat.give` (call it on every machine, or use a HeatSource, when every player should agree).
## Readability
Under thermal, players, enemies and pickups are told apart by sensorBlocks' role cues (outline and slow friend-or-foe blink for you and allies, outline and hatching for enemies, shimmer for pickups, dashed outline for hazards), not by temperature alone, so a guard standing by a fire still reads as a guard.
## What it costs
The heat field packs at most 64 shapes into a 65x5 data texture every other frame, on the machine showing a thermal look and only while a block asks for heat. Still things (metal, stone, water) update a slice at a time, about once a second each. Moving and working things update on alternate frames. The nearest 64 in view are picked four times a second, and the scene is scanned for names every ten seconds, a few hundred entities a frame. In the forest showcase with 2,500 extra objects (312 crates and 50 guards picked up by name), a typical frame spends about 0.19 ms of script time on heat. The sensorBlocks README has the measured engine CPU and GPU per look, on desktop and in the browser.
## Known limits
- **Engine bug, custom surface shaders (current engine, @builtin 024ebe5):** a custom surface shader compiled fresh fails with `#include of unknown shader module "zero::projection"` (reported to the platform: 01M7AV5R97GJHWXB4019TT3E65). The heat buffer (`heatObj`) is one. Where the engine already holds its compiled program it draws exact per-object heat; where it fails, thermal falls back to the soft heat shapes, so people, animals and fires still read warm with softer outlines.
- Heat shapes are boxes or ellipsoids fitted to each thing's bounds when first seen; a thing that changes size keeps its first fit.
- At most the 64 heat shapes nearest the camera are drawn (gameplay calls see all of them).
- The data texture falls back to rgba16f where the preferred float format is missing.
- Transparent things (glass, water surfaces) are not in the depth and show the heat of what is behind them; give water a name heatSignatures knows or a HeatSource.
- Offscreen captures, mirrors and render-to-texture cameras do not show the style stack, so they show no heat.
- Players who join late miss warm prints left before they joined.
- Infrared reflectance and foliage are guessed from base colour, not from real material data.
## Version history
- **1.0.9**: `Heat.give` on an entity now takes over from the name rule's record for it, the way a HeatSource component already did. Before, an entity whose name matched a rule (a built "...campfire", a "flame" part) kept its rule's 420 C record beside the script's, so a script could never say that fire had gone out.
- **1.0.8**: built against the current engine library (@builtin 024ebe5); Known limits names the engine bug that can keep the heat buffer's surface shader from compiling, and what thermal falls back to.
- **1.0.7**: the heat pass regroups its objects at most about three times a second when sources change, and once a second otherwise; version history without dates.
- **1.0.6**: renamed from heatKit to heatSignatures (every `~heatKit.` path is now `~heatSignatures.`; components are `heatSignatures.HeatSource` and `heatSignatures.HeatClimate`); with a block reading heat the heat bookkeeping runs five times a second on its own clock, since the GPU heat buffer draws every source's mesh where it stands.
- **1.0.5**: heat drawn on the GPU (heatSignatures's HeatPass: one geometry pass into a heat buffer, each object's heat in a shader-data lane; thermal blocks read `input:heatObj`); scripts keep only soft shapes for prints, radiant warmth and mesh-less sources; heat tick every fourth frame on heatSignatures's own clock; scans, new sources and clean-up spread over frames; climate cached; heatSignatures's render feature restarts itself if the engine stops it; styleKit 1.8.1; SensorBench checks that heat was live in every thermal window.
- **1.0.4**: lighter per-frame work: name scans use the engine's own name search and remember each name stem; moving heat sources and contacts are read from the engine every fourth frame and dead-reckoned in between; the heat tick keeps separate moving and still lists and runs once a second when no look needs heat; 40 heat shapes and 16 contacts drawn (smaller data textures); the climate component no longer runs every frame; SensorBench measures in alternating look-on and look-off windows and reports the median; What it costs updated with desktop and browser numbers.
- **1.0.2**: fixes the gen-3 night vision look, whose look file was damaged in 1.0.1 so styleKit could not read it; heat and contact data are uploaded every other frame; x-ray thickness passes draw at half resolution (the airport scanner went from 4.5 to 0.24 ms of GPU with 2,500 objects); the name scans run every ten seconds; each runtime keeps asking for styleKit until it answers; SensorBench (measure a look's engine CPU and GPU cost on this device); What it costs measured as the engine's own per-system CPU and per-pass GPU time.
- **1.0.1**: a shared clock every machine agrees on for heat prints and pings (ages never step back); per-frame work trimmed (reused arrays, static heat sources updated a slice at a time, only heat shapes in view and worth drawing are packed, lighter night vision shader); `Heat.of` reads player bodies; `Sensors.use(look, { shared = true })` makes the scene's style stack when there is none; What it costs section.
- **1.0.0**: first release. Heat model with fourteen classes and name rules, players as warm people, warming and cooling with work and motion, shared warm prints, five climates, HeatSource and HeatClimate components, the heat input for styleKit and the `hk_temp` shader module.
# Heat (module)
heatSignatures's temperature model: every thing in the world has a heat in degrees Celsius, for a thermal camera to draw and for gameplay to read. Game scripts call it to ask how hot something is (`Heat.at`, `Heat.of`), to give a thing heat (`Heat.give`), to leave a warm hand print (`Heat.touch`) and to set the weather heat sits in (`Heat.setClimate`). Thermal style blocks (sensorBlocks) and sensorGoggles' readout read it through HeatField.
```luau
local Heat = require("~heatSignatures.Heat")
Heat.setClimate("desertDay") -- every player
Heat.setClimate("temperateNight", { air = 2 }) -- with overrides
print(Heat.at(player.position)) -- degrees C at a point
print(Heat.of(entity.find("Guard1"))) -- one thing's temperature
Heat.give(entity.find("Reactor"), "engine", { active = 140, working = true })
Heat.take(entity.find("Reactor"))
Heat.touch(door.position, { life = 45 }) -- a fading warm print, shared
Heat.addRule("reactor", "engine") -- your own name rule
Heat.setAuto(false) -- stop finding things by name
```
## What it gives
| Call | What it does |
|---|---|
| `Heat.at(pos)` | Temperature at a point: the climate's air with every heat shape and warm print reaching it, plus the radiant warmth of fires and lamps near it. |
| `Heat.of(entity)` | Temperature of a thing heatSignatures knows (HeatSource, Heat.give, a name rule), or the air for anything else. |
| `Heat.give(entity, class, opts)` | Script-made heat on this machine. opts: `temp`, `active`, `working`, `size`, `offset`. |
| `Heat.take(entity)` | Takes a `Heat.give` off. |
| `Heat.touch(pos, opts)` | A warm print that fades (`temp` 31, `life` 30 s, `radius` 0.12 m by default), sent to every player. |
| `Heat.setClimate(id, overrides)` | Puts the scene in a climate for every player (makes the synced HeatClimate entity when there is none). |
| `Heat.climate()` / `Heat.climates()` | The climate now, with every value filled in / every heatClimate asset installed. |
| `Heat.addRule(pattern, class)` / `Heat.classForName(name)` | Name rules: a word in an entity's name gives it a class. |
| `Heat.setAuto(on)` | Finding things by name on or off (on by default). |
| `Heat.sources()` / `Heat.prints()` | Every heat shape held now / the warm prints still fading. |
| `Heat.CLASSES` / `Heat.DEFAULT_RULES` | The classes (person, animal, engine, vehicle, fire, lamp, electronics, metal, stone, water, ice, plant, warm, cold) and the default name rules. |
## How things get heat without tagging
- Names: `Campfire`, `Guard2`, `Generator`, `Fox`, `Crate3`, `Stream` and dozens more words match a class. A match on a parent covers its children.
- Players: every player's body is a warm person, whatever it is called.
- Moving and working: people, animals and vehicles warm toward their active temperature while they move; anything `working` warms too. They warm over `warmUp` seconds and cool at half that speed.
- The render side also reads surfaces: green reads as leaves near the air, glowing pixels read hot, metal has low emissivity so it mirrors the cold sky.
## Known limits
- Heat shapes are boxes or ellipsoids fitted to a thing's bounds when it is first seen; a thing that changes size keeps its first fit.
- `Heat.give` is per machine: run it on every machine (or use a synced HeatSource) so every player agrees.
- Warm prints sent before a player joined are not replayed to them.